Agora Java API Reference for Android
|
Public Member Functions | |
ChannelMediaOptions (Integer clientRoleType) | |
Boolean | isPublishCameraTrack () |
Boolean | isPublishSecondaryCameraTrack () |
Boolean | isPublishScreenTrack () |
Boolean | isPublishCustomAudioTrack () |
Boolean | isPublishCustomAudioTrackEnableAec () |
Boolean | isPublishCustomAudioTrackAec () |
Boolean | isPublishDirectCustomAudioTrack () |
Boolean | isPublishCustomVideoTrack () |
Boolean | isPublishEncodedVideoTrack () |
Boolean | isPublishMediaPlayerAudioTrack () |
Boolean | isPublishMediaPlayerVideoTrack () |
Integer | getPublishMediaPlayerId () |
Boolean | isPublishAudioTrack () |
Boolean | isAutoSubscribeAudio () |
Boolean | isAutoSubscribeVideo () |
Boolean | isStartPreview () |
Boolean | isEnableAudioRecordingOrPlayout () |
Integer | getClientRoleType () |
Integer | getAudienceLatencyLevel () |
Integer | getDefaultVideoStreamType () |
Integer | getChannelProfile () |
Integer | getAudioDelayMs () |
Integer | getMediaPlayerAudioDelayMs () |
String | getToken () |
Boolean | isEnableBuiltInMediaEncryption () |
Boolean | getPublishRhythmPlayerTrack () |
Integer | getPublishCustomAudioSourceId () |
Boolean | isInteractiveAudience () |
String | toString () |
Public Attributes | |
Boolean | publishCameraTrack |
Boolean | publishSecondaryCameraTrack |
Boolean | publishScreenTrack |
Boolean | publishCustomAudioTrack |
Boolean | publishCustomAudioTrackEnableAec |
Boolean | publishCustomAudioTrackAec |
Boolean | publishDirectCustomAudioTrack |
Boolean | publishCustomVideoTrack |
Boolean | publishEncodedVideoTrack |
Boolean | publishMediaPlayerAudioTrack |
Boolean | publishMediaPlayerVideoTrack |
Boolean | publishRhythmPlayerTrack |
Integer | publishMediaPlayerId |
Boolean | publishAudioTrack |
Boolean | autoSubscribeAudio |
Boolean | autoSubscribeVideo |
Boolean | startPreview |
Boolean | enableAudioRecordingOrPlayout |
Integer | clientRoleType |
Integer | audienceLatencyLevel |
Integer | defaultVideoStreamType |
Integer | channelProfile |
Integer | audioDelayMs |
Integer | mediaPlayerAudioDelayMs |
String | token |
Boolean | enableBuiltInMediaEncryption |
Integer | publishCustomAudioSourceId |
Boolean | isInteractiveAudience |
The channel media options.
Boolean io.agora.rtc2.ChannelMediaOptions.publishCameraTrack |
Determines whether to publish the video of the camera track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishSecondaryCameraTrack |
Determines whether to publish the video of the secondary camera track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishScreenTrack |
Determines whether to publish the video of the screen track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishCustomAudioTrack |
Determines whether to publish the audio of the custom audio track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishCustomAudioTrackEnableAec |
Determines whether to enable AEC when publish custom audio track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishCustomAudioTrackAec |
Determines whether to publish AEC custom audio track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishDirectCustomAudioTrack |
Determines whether to publish direct custom audio track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishCustomVideoTrack |
Determines whether to publish the video of the custom video track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishEncodedVideoTrack |
Determines whether to publish the video of the encoded video track.
Boolean io.agora.rtc2.ChannelMediaOptions.publishMediaPlayerAudioTrack |
Determines whether to publish the audio track of media player source.
Boolean io.agora.rtc2.ChannelMediaOptions.publishMediaPlayerVideoTrack |
Determines whether to publish the video track of media player source.
Boolean io.agora.rtc2.ChannelMediaOptions.publishRhythmPlayerTrack |
Determines whether to publish the sound of the rhythm player to remote users.
Integer io.agora.rtc2.ChannelMediaOptions.publishMediaPlayerId |
Determines which media player source should be published.
Boolean io.agora.rtc2.ChannelMediaOptions.publishAudioTrack |
Determines whether to publish the recorded audio. This method replaces calling muteLocalAudioStream before joining a channel.
Boolean io.agora.rtc2.ChannelMediaOptions.autoSubscribeAudio |
Determines whether to subscribe to all audio streams automatically.
This member replaces calling setDefaultMuteAllRemoteAudioStreams before joining a channel.
Boolean io.agora.rtc2.ChannelMediaOptions.autoSubscribeVideo |
Determines whether to subscribe to all video streams automatically.
This member replaces calling setDefaultMuteAllRemoteVideoStreams before joining a channel.
Boolean io.agora.rtc2.ChannelMediaOptions.startPreview |
Determines whether to start preview when join channel if canvas have been set.
Boolean io.agora.rtc2.ChannelMediaOptions.enableAudioRecordingOrPlayout |
Determines whether to enable audio recording or playout.
Integer io.agora.rtc2.ChannelMediaOptions.clientRoleType |
The client role type:
CLIENT_ROLE_BROADCASTER
(1): The broadcaster, who can both send and receive streams.CLIENT_ROLE_AUDIENCE
(2): (Default) The audience, who can only receive streams. Integer io.agora.rtc2.ChannelMediaOptions.audienceLatencyLevel |
The audience latency level type:
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY
(1): Low latency. A low latency audience's play out latency is 1.5 second.AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY
(2): (Default) Ultra low latency. An ultra low latency audience's play out latency is 0.5 second. Integer io.agora.rtc2.ChannelMediaOptions.defaultVideoStreamType |
The default video stream type to subscribe to:
VIDEO_STREAM_HIGH
(0): (Default) The high-stream video, that is, the video stream featuring in high resolution and high bitrate.VIDEO_STREAM_LOW
(1): The low-stream video, that is, the video stream featuring in low resolution and low bitrate. Integer io.agora.rtc2.ChannelMediaOptions.channelProfile |
The channel profile:
CHANNEL_PROFILE_COMMUNICATION
(0): Communication. Use this profile in one-on-one calls or group calls, where all users can talk freely.CHANNEL_PROFILE_LIVE_BROADCASTING
(1): (Default) Live Broadcast. Users in a live-broadcast channel has a role as either broadcaster or audience. A broadcaster can both send and receive streams; an audience can only receive streams.CHANNEL_PROFILE_GAME
(2): Gaming. This profile uses a codec with a low bitrate and consumes less power. Applies to the gaming scenario, where all game players can talk freely. Integer io.agora.rtc2.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.
Integer io.agora.rtc2.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.
String io.agora.rtc2.ChannelMediaOptions.token |
The token to be renewed
Boolean io.agora.rtc2.ChannelMediaOptions.enableBuiltInMediaEncryption |
Enable media packet encryption. This parameter is ignored when calling function updateChannelMediaOptions()
Integer io.agora.rtc2.ChannelMediaOptions.publishCustomAudioSourceId |
Determines the source id of the custom audio, default is 0.
Boolean io.agora.rtc2.ChannelMediaOptions.isInteractiveAudience |
This mode is only used for audience. In PK mode, client might join one channel as broadcaster, and join another channel as interactive audience to achieve low lentancy and smooth video from remote user.