Agora C++ API Reference for All Platforms
|
Public Member Functions | |
ChannelMediaOptions () | |
~ChannelMediaOptions () | |
void | SetAll (const ChannelMediaOptions &change) |
bool | operator== (const ChannelMediaOptions &o) const |
ChannelMediaOptions & | operator= (const ChannelMediaOptions &replace) |
The channel media options.
Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishAudioTrack
, publishCustomAudioTrack
and publishMediaPlayerAudioTrack
can be true at the same time; but only one of publishCameraTrack
, publishScreenTrack
, publishCustomVideoTrack
, and publishEncodedVideoTrack
can be true at the same time.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Optional<bool> agora::rtc::ChannelMediaOptions::publishCameraTrack |
Whether to publish the video of the camera track.
true
: (Default) Publish the video track of the camera capturer.false
: Do not publish the video track of the camera capturer. Optional<bool> agora::rtc::ChannelMediaOptions::publishSecondaryCameraTrack |
Whether to publish the video of the secondary camera track.
true
: (Default) Publish the video track of the secondary camera capturer.false
: Do not publish the video track of the secondary camera capturer. Optional<bool> agora::rtc::ChannelMediaOptions::publishMicrophoneTrack |
Whether to publish the recorded audio.
true
: (Default) Publish the recorded audio.false
: Do not publish the recorded audio. Optional<bool> agora::rtc::ChannelMediaOptions::publishScreenCaptureVideo |
Whether to publish the video track of the screen capturer:
true
: Publish the video track of the screen capture.false
: (Default) Do not publish the video track of the screen capture. Optional<bool> agora::rtc::ChannelMediaOptions::publishScreenCaptureAudio |
Whether to publish the audio track of the screen capturer:
true
: Publish the video audio of the screen capturer.false
: (Default) Do not publish the audio track of the screen capturer. Optional<bool> agora::rtc::ChannelMediaOptions::publishScreenTrack |
Whether to publish the captured video from the screen:
true
: PPublish the captured video from the screen.false
: (Default) Do not publish the captured video from the screen. Optional<bool> agora::rtc::ChannelMediaOptions::publishSecondaryScreenTrack |
Whether to publish the captured video from the secondary screen:
Optional<bool> agora::rtc::ChannelMediaOptions::publishCustomAudioTrack |
Whether to publish the captured audio from a custom source:
Optional<int> agora::rtc::ChannelMediaOptions::publishCustomAudioSourceId |
The ID of the custom audio source to publish. The default value is 0.
If you have set the value of sourceNumber
greater than 1 in setExternalAudioSource
, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track starting from 0.
Optional<bool> agora::rtc::ChannelMediaOptions::publishCustomAudioTrackEnableAec |
Whether to enable AEC when publishing the captured audio from a custom source:
true
: Enable AEC when publishing the captured audio from a custom source.false
: (Default) Do not enable AEC when publishing the captured audio from a custom source. Optional<bool> agora::rtc::ChannelMediaOptions::publishDirectCustomAudioTrack |
Whether to publish direct custom audio track.
true
: Publish.false
: (Default) Do not publish. Optional<bool> agora::rtc::ChannelMediaOptions::publishCustomAudioTrackAec |
Whether to publish AEC custom audio track.
true
: Publish AEC track.false
: (Default) Do not publish AEC track. Optional<bool> agora::rtc::ChannelMediaOptions::publishCustomVideoTrack |
Whether to publish the captured video from a custom source:
true
: Publish the captured video from a custom source.false
: (Default) Do not publish the captured video from the custom source. Optional<bool> agora::rtc::ChannelMediaOptions::publishEncodedVideoTrack |
Whether to publish the encoded video:
true
: Publish the encoded video.false
: (Default) Do not publish the encoded video. Optional<bool> agora::rtc::ChannelMediaOptions::publishMediaPlayerAudioTrack |
Whether to publish the audio from the media player:
true
: Publish the audio from the media player.false
: (Default) Do not publish the audio from the media player. Optional<bool> agora::rtc::ChannelMediaOptions::publishMediaPlayerVideoTrack |
Whether to publish the video from the media player:
true
: Publish the video from the media player.false
: (Default) Do not publish the video from the media player. Optional<bool> agora::rtc::ChannelMediaOptions::publishTrancodedVideoTrack |
Whether to publish the local transcoded video track.
true
: Publish the video track of local transcoded video track.false
: (Default) Do not publish the local transcoded video track. Optional<bool> agora::rtc::ChannelMediaOptions::autoSubscribeAudio |
Whether to automatically subscribe to all remote audio streams when the user joins a channel:
true
: (Default) Subscribe to all remote audio streams.false
: Do not subscribe to any remote audio stream. Optional<bool> agora::rtc::ChannelMediaOptions::autoSubscribeVideo |
Whether to subscribe to all remote video streams when the user joins the channel:
true
: (Default) Subscribe to all remote video streams.false
: Do not subscribe to any remote video stream. Optional<bool> agora::rtc::ChannelMediaOptions::enableAudioRecordingOrPlayout |
Whether to enable audio capturing or playback.
true
: (Default) Enable audio capturing and playback.false
: Do not enable audio capturing or playback. Optional<int> agora::rtc::ChannelMediaOptions::publishMediaPlayerId |
The ID of the media player to be published. The default value is 0.
Optional<CLIENT_ROLE_TYPE> agora::rtc::ChannelMediaOptions::clientRoleType |
The client role type. See CLIENT_ROLE_TYPE. Default is CLIENT_ROLE_AUDIENCE.
Optional<AUDIENCE_LATENCY_LEVEL_TYPE> agora::rtc::ChannelMediaOptions::audienceLatencyLevel |
The audience latency level type. See AUDIENCE_LATENCY_LEVEL_TYPE.
Optional<VIDEO_STREAM_TYPE> agora::rtc::ChannelMediaOptions::defaultVideoStreamType |
The default video stream type. See VIDEO_STREAM_TYPE. Default is VIDEO_STREAM_HIGH.
Optional<CHANNEL_PROFILE_TYPE> agora::rtc::ChannelMediaOptions::channelProfile |
The channel profile. See CHANNEL_PROFILE_TYPE. Default is CHANNEL_PROFILE_LIVE_BROADCASTING.
Optional<int> agora::rtc::ChannelMediaOptions::audioDelayMs |
The delay in ms for sending audio frames. This is used for explicit control of A/V sync. To switch off the delay, set the value to zero.
Optional<int> agora::rtc::ChannelMediaOptions::mediaPlayerAudioDelayMs |
The delay in ms for sending media player audio frames. This is used for explicit control of A/V sync. To switch off the delay, set the value to zero.
Optional<const char*> agora::rtc::ChannelMediaOptions::token |
(Optional) The token generated on your server for authentication.
updateChannelMediaOptions
or updateChannelMediaOptionsEx
.joinChannel [2/2]
and joinChannelEx
methods for joining the channel. Optional<bool> agora::rtc::ChannelMediaOptions::enableBuiltInMediaEncryption |
Whether to enable media packet encryption:
true
: Yes.false
: (Default) No.updateChannelMediaOptions
. Optional<bool> agora::rtc::ChannelMediaOptions::publishRhythmPlayerTrack |
Whether to publish the sound of the rhythm player to remote users:
true
: (Default) Publish the sound of the rhythm player.false
: Do not publish the sound of the rhythm player. Optional<bool> agora::rtc::ChannelMediaOptions::isInteractiveAudience |
Whether the user is an interactive audience member in the channel.
true
: Enable low lentancy and smooth video when joining as an audience.false
: (Default) Use default settings for audience role. Optional<video_track_id_t> agora::rtc::ChannelMediaOptions::customVideoTrackId |
The custom video track id which will used to publish or preview. You can get the VideoTrackId after calling createCustomVideoTrack() of IRtcEngine.
Optional<bool> agora::rtc::ChannelMediaOptions::isAudioFilterable |
Whether local audio stream can be filtered.
true
: (Default) Can be filtered when audio level is low.false
: Do not Filter this audio stream.