|
Agora Java API Reference for Android
|
#include <IAgoraRtcEngine.h>
Public Member Functions | |
| 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.
| 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: Publish the video track of the secondary camera capturer.false: (Default) Do not publish the video track of the secondary camera capturer. | Optional<bool> agora::rtc::ChannelMediaOptions::publishThirdCameraTrack |
Whether to publish the video of the third camera track.
true: Publish the video track of the third camera capturer.false: (Default) Do not publish the video track of the third camera capturer. | Optional<bool> agora::rtc::ChannelMediaOptions::publishFourthCameraTrack |
Whether to publish the video of the fourth camera track.
true: Publish the video track of the fourth camera capturer.false: (Default) Do not publish the video track of the fourth 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::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::publishThirdScreenTrack |
Whether to publish the captured video from the third screen:
| Optional<bool> agora::rtc::ChannelMediaOptions::publishFourthScreenTrack |
Whether to publish the captured video from the fourth screen:
| Optional<bool> agora::rtc::ChannelMediaOptions::publishCustomAudioTrack |
Whether to publish the captured audio from a custom source:
| Optional<int> agora::rtc::ChannelMediaOptions::publishCustomAudioTrackId |
The custom audio track id. The default value is 0.
| 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::publishTranscodedVideoTrack |
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::publishMixedAudioTrack |
Whether to publish the local mixed track.
true: Publish the audio track of local mixed track.false: (Default) Do not publish the local mixed track. | Optional<bool> agora::rtc::ChannelMediaOptions::publishLipSyncTrack |
Whether to publish the local lip sync video track.
true: Publish the video track of local lip sync video track.false: (Default) Do not publish the local lip sync 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. | Optional<const char*> agora::rtc::ChannelMediaOptions::parameters |
Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options. Pointer to the set parameters in a JSON string. @technical preview
1.8.18