|typedef unsigned int||uid_t|
|typedef void *||view_t|
|typedef struct agora::rtc::TranscodingUser||TranscodingUser|
|typedef struct agora::rtc::RtcImage||RtcImage|
|typedef struct agora::rtc::LiveTranscoding||LiveTranscoding|
|typedef struct agora::rtc::Rect||Rect|
|typedef struct agora::rtc::WatermarkOptions||WatermarkOptions|
|const int||STANDARD_BITRATE = 0|
|const int||COMPATIBLE_BITRATE = -1|
|const int||DEFAULT_MIN_BITRATE = -1|
|typedef unsigned int agora::rtc::uid_t|
|typedef void* agora::rtc::view_t|
The video and audio properties of the user displaying the video in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN streaming channel.
The properties of the watermark and background images.
A struct for managing CDN live audio/video transcoding settings.
The options of the watermark image to be added.
Enumeration Type Documentation
The states of the local user's audio mixing file.
710: The audio mixing file is playing.
711: The audio mixing file pauses playing.
713: The audio mixing file stops playing.
714: An exception occurs when playing the audio mixing file. See AUDIO_MIXING_ERROR_TYPE.
The error codes of the local user's audio mixing file.
Media device types.
Local video state types
0: Initial state
1: The local video capturing device starts successfully.
The SDK also reports this state when you share a maximized window by calling startScreenCaptureByWindowId.
2: The first video frame is successfully encoded.
3: The local video fails to start.
Local video state error codes
0: The local video is normal.
1: No specified reason for the local video failure.
2: No permission to use the local video capturing device.
3: The local video capturing device is in use.
4: The local video capture fails. Check whether the capturing device is working properly.
5: The local video encoding fails.
11: The shared window is minimized when you call startScreenCaptureByWindowId to share a window.
Local audio state types.
Local audio state error codes.
Audio recording qualities.
Network quality types.
Video display modes.
DEPRECATED Video profiles.
Sets the sample rate, bitrate, encoding mode, and the number of channels:
Audio application scenarios.
The channel profile.
Reasons for a user being offline.
States of the RTMP streaming.
The RTMP streaming has not started or has ended. This state is also triggered after you remove an RTMP address from the CDN by calling removePublishStreamUrl.
The SDK is connecting to Agora's streaming server and the RTMP server. This state is triggered after you call the addPublishStreamUrl method.
The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state.
The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP streaming and returns this state.
The RTMP streaming fails. See the errCode parameter for the detailed error information. You can also call the addPublishStreamUrl method to publish the RTMP streaming again.
Error codes of the RTMP streaming.
The RTMP streaming publishes successfully.
Invalid argument used. If, for example, you do not call the setLiveTranscoding method to configure the LiveTranscoding parameters before calling the addPublishStreamUrl method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly.
The RTMP streaming is encrypted and cannot be published.
Timeout for the RTMP streaming. Call the addPublishStreamUrl method to publish the streaming again.
An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again.
An error occurs in the RTMP server.
The RTMP streaming publishes too frequently.
The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
The host manipulates other hosts' URLs. Check your app logic.
Agora's server fails to find the RTMP streaming.
The format of the RTMP streaming URL is not supported. Check whether the URL format is correct.
States of importing an external video stream in the live interactive streaming.
0: Read-only mode: Users only read the AudioFrame data without modifying anything. For example, when users acquire the data with the Agora SDK, then push the RTMP streams.
1: Write-only mode: Users replace the AudioFrame data with their own data and pass the data to the SDK for encoding. For example, when users acquire the data.
2: Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own sound-effect processing module and perform some voice pre-processing, such as a voice change.
Video codec profile types.
Audio equalization band frequencies.
Audio reverberation types.
Local voice changer options.
Local voice reverberation presets.
Remote audio states.
1: The first remote audio packet is received.
3: The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION (1).
4: The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL (0).
Remote audio state reasons.
Remote video states. 1: The remote video is playing. 2: The remote video is frozen. The state of the remote video.
1: The first remote video packet is received.
2: The remote video stream is decoded and plays normally, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY (2), REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED (4), REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6), or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY (9).
4: The remote video fails to start, probably due to REMOTE_VIDEO_STATE_REASON_INTERNAL (0).
The publishing state.
0: The initial publishing state after joining the channel.
1: Fails to publish the local stream. Possible reasons:
3: Publishes successfully.
The subscribing state.
0: The initial subscribing state after joining the channel.
1: Fails to subscribe to the remote stream. Possible reasons:
3: Subscribes to and receives the remote stream successfully.
The reason for the remote video state change.
Video output orientation modes.
Video degradation preferences when the bandwidth is a constraint.
Stream fallback options.
0: No fallback behavior for the local/remote video stream when the uplink/downlink network conditions are poor. The quality of the stream is not guaranteed.
1: Under poor downlink network conditions, the remote video stream, to which you subscribe, falls back to the low-stream (low resolution and low bitrate) video. You can set this option only in the setRemoteSubscribeFallbackOption method. Nothing happens when you set this in the setLocalPublishFallbackOption method.
2: Under poor uplink network conditions, the published video stream falls back to audio only.
Under poor downlink network conditions, the remote video stream, to which you subscribe, first falls back to the low-stream (low resolution and low bitrate) video; and then to an audio-only stream if the network conditions worsen.
Camera capturer configuration.
0: (Default) self-adapts the camera output parameters to the system performance and network conditions to balance CPU consumption and video preview quality.
1: Prioritizes the system performance. The SDK chooses the dimension and frame rate of the local camera capture closest to those set by setVideoEncoderConfiguration.
2: Prioritizes the local preview quality. The SDK chooses higher camera output parameters to improve the local video preview quality. This option requires extra CPU and RAM usage for video pre-processing.
1: The SDK is disconnected from Agora's edge server.
2: The SDK is connecting to Agora's edge server.
3: The SDK is connected to Agora's edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel.
If the connection to the channel is lost because, for example, if the network is down or switched, the SDK automatically tries to reconnect and triggers:
4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
5: The SDK fails to connect to Agora's edge server or join the channel.
Reasons for a connection state change.
0: The SDK is connecting to Agora's edge server.
1: The SDK has joined the channel successfully.
2: The connection between the SDK and Agora's edge server is interrupted.
3: The connection between the SDK and Agora's edge server is banned by Agora's edge server.
4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
5: The SDK has left the channel.
6: The connection failed since Appid is not valid.
7: The connection failed since channel name is not valid.
8: The connection failed since token is not valid, possibly because:
9: The connection failed since token is expired.
10: The connection is rejected by server.
11: The connection changed to reconnecting since SDK has set a proxy server.
12: When SDK is in connection failed, the renew token operation will make it connecting.
13: The IP Address of SDK client has changed. i.e., Network type or IP/Port changed by network operator might change client IP address.
14: Timeout for the keep-alive of the connection between the SDK and Agora's edge server. The connection state changes to CONNECTION_STATE_RECONNECTING(4).
States of the last-mile network probe test.
Audio output routing.
Audio session restriction.
Quality change of the local video in terms of target frame rate and target bit rate since last count.
The quality of the local video stays the same.
The quality improves because the network bandwidth increases.
The quality worsens because the network bandwidth decreases.
The error code in CHANNEL_MEDIA_RELAY_ERROR.
0: The state is normal.
1: An error occurs in the server response.
2: No server response. You can call the leaveChannel method to leave the channel.
3: The SDK fails to access the service, probably due to limited resources of the server.
4: Fails to send the relay request.
5: Fails to accept the relay request.
6: The server fails to receive the media stream.
7: The server fails to send the media stream.
8: The SDK disconnects from the server due to poor network connections. You can call the leaveChannel method to leave the channel.
9: An internal error occurs in the server.
10: The token of the source channel has expired.
11: The token of the destination channel has expired.
The event code in CHANNEL_MEDIA_RELAY_EVENT.
The state code in CHANNEL_MEDIA_RELAY_STATE.
DEPRECATED Lifecycle of the CDN live video stream.
Content hints for screen sharing.
|const int agora::rtc::STANDARD_BITRATE = 0|
(Recommended) The standard bitrate set in the setVideoEncoderConfiguration method.
In this mode, the bitrates differ between the live interactive streaming and communication profiles:
COMMUNICATIONprofile: The video bitrate is the same as the base bitrate.
LIVE_BROADCASTINGprofile: The video bitrate is twice the base bitrate.
|const int agora::rtc::COMPATIBLE_BITRATE = -1|
The compatible bitrate set in the setVideoEncoderConfiguration method.
The bitrate remains the same regardless of the channel profile. If you choose this mode in the
LIVE_BROADCASTING profile, the video frame rate may be lower than the set value.
|const int agora::rtc::DEFAULT_MIN_BITRATE = -1|
Use the default minimum bitrate.