package
0.0.0-20240909193252-fb003f15bb62
Repository: https://github.com/agoraio-community/agora-go-backend-middleware.git
Documentation: pkg.go.dev

# Functions

NewCloudRecordingService returns a CloudRecordingService pointer with all configurations set.

# Structs

AcquireResourceRequest defines the structure for a request to acquire resources for cloud recording.
ActiveRecordingResponse represents the current state of a recording session.
AppsCollection represents a collection of application settings used during the recording.
AquireClientRequest defines the parameters for acquiring a cloud recording resource.
Audio specifies the audio settings used in transcoding, affecting quality and compatibility.
AudioUidList defines the UIDs for subscribing to or unsubscribing from audio streams.
BackgroundConfig specifies the background settings for individual participants or the entire session.
ClientRequest contains the detailed parameters for starting or updating a recording session.
ClientStartRecordingRequest represents the JSON payload structure sent by the client to start a cloud recording.
ClientStopRecordingRequest represents the JSON payload structure for requesting the stop of a cloud recording.
ClientUpdateLayoutRequest represents the JSON payload for updating the layout of a cloud recording session.
ClientUpdateSubscriptionRequest represents the JSON payload structure sent by the client to update a cloud recording's subscription.
CloudRecordingService represents the cloud recording service.
Container represents the container format for the recorded media files.
ExtensionParams adds further customization to the storage configuration, supporting specific features of the storage provider.
ExtensionService defines a single service that can extend the functionality of cloud recording, such as additional processing or streaming capabilities.
ExtensionServiceConfig holds configuration for any extension services used during recording.
ExtensionServiceState details the state of any extension services used during the recording, such as additional data streaming or processing services.
FileDetail provides specific details about a recorded file, including its name and the start time of the recording slice it contains.
FileListEntry details a file in a list of recorded files, including track type and whether it includes all users' mixed audio/video.
LayoutConfig defines individual video layout positions and dimensions for participants in a recorded session.
Output defines the URL and additional parameters for an RTMP stream.
PlayloadStop contains details about the stopping condition of an extension service, including file list and recording state.
RecordingConfig encapsulates all settings related to the recording process itself.
RecordingFileConfig represents the configuration for recorded files, specifically the types of audio/video files.
RTMPPublishConfig defines the configuration for RTMP publishing, including output URLs.
ServerResponse encapsulates various possible states and details returned by the Agora server in response to recording commands.
ServiceParam encapsulates the parameters for an extension service, which can include video and audio settings.
SnapshotConfig specifies the settings for taking snapshots during a cloud recording session.
StartRecordingRequest defines the structure for a request to start a cloud recording.
StartRecordingResponse represents the response received from the Agora server after successfully starting a recording.
StopClientRequest defines additional parameters that can be specified when stopping a cloud recording.
StopRecordingRequest defines the structure for a request to stop a cloud recording.
StorageConfig represents the details necessary for storing recorded content.
StreamSubscribe defines the UID lists for subscribing to or unsubscribing from audio and video streams.
TranscodeOptions encapsulates options for transcoding the recording, including video and audio configuration.
TranscodingConfig specifies the parameters for video transcoding during the recording process.
TransConfig defines the transcoding mode used for converting media from one format to another.
UpdateLayoutClientRequest encapsulates the parameters for configuring the video layout in a cloud recording.
UpdateLayoutRequest defines the structure for a request to update the layout of a cloud recording.
UpdateRecordingResponse represents the response from updating a recording session's settings.
UpdateSubscriptionClientRequest encapsulates the various configurations that can be modified in a subscription update request.
UpdateSubscriptionRequest defines the structure for a request to update a subscription for a cloud recording.
VideoUidList defines the UIDs for subscribing to or unsubscribing from video streams.
WebRecordingConfig specifies the on-hold status of a web recording.

# Interfaces

Timestampable is an interface that allows struct types to receive a timestamp.