Package io.agora.rtc2

Class ChannelMediaOptions

java.lang.Object
io.agora.rtc2.ChannelMediaOptions
public class ChannelMediaOptions extends Object

  • Field Details

    • publishCameraTrack

      public Boolean publishCameraTrack
      Whether to publish the video captured by the camera: - `true`: Publish the video captured by the camera. - `false`: Do not publish the video captured by the camera.

    • publishSecondaryCameraTrack

      public Boolean publishSecondaryCameraTrack
      Determines 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.

    • publishThirdCameraTrack

      public Boolean publishThirdCameraTrack
      Whether to publish the video captured by the third camera: - `true`: Publish the video captured by the third camera. - `false`: Do not publish the video captured by the third camera.

    • publishFourthCameraTrack

      public Boolean publishFourthCameraTrack
      Whether to publish the video captured by the fourth camera: - `true`: Publish the video captured by the fourth camera. - `false`: Do not publish the video captured by the fourth camera.

    • publishMicrophoneTrack

      public Boolean publishMicrophoneTrack
      Whether to publish the audio captured by the microphone: - `true`: Publish the audio captured by the microphone. - `false`: Do not publish the audio captured by the microphone.

    • publishScreenCaptureVideo

      public Boolean publishScreenCaptureVideo
      Whether to publish the video captured from the screen: - `true`: Publish the video captured from the screen. - `false`: Do not publish the video captured from the screen.

    • publishScreenCaptureAudio

      public Boolean publishScreenCaptureAudio
      Whether to publish the audio captured from the screen: - `true`: Publish the audio captured from the screen. - `false`: Publish the audio captured from the screen.

    • publishCustomAudioTrack

      public Boolean publishCustomAudioTrack
      Whether to publish the audio captured from a custom source: - `true`: Publish the audio captured from the custom source. - `false`: Do not publish the captured audio from a custom source.

    • publishCustomAudioTrackId

      public Integer publishCustomAudioTrackId
      The ID of the custom audio track to be published. The default value is 0. You can obtain the custom audio track ID through the `createCustomAudioTrack` method.

    • publishCustomVideoTrack

      public Boolean publishCustomVideoTrack
      Whether to publish the video captured from a custom source: - `true`: Publish the video captured from the custom source. - `false`: Do not publish the captured video from a custom source.

    • publishEncodedVideoTrack

      public Boolean publishEncodedVideoTrack
      Whether to publish the encoded video: - `true`: Publish the encoded video. - `false`: Do not publish the encoded video.

    • publishMediaPlayerAudioTrack

      public Boolean publishMediaPlayerAudioTrack
      Whether to publish the audio from the media player: - `true`: Publish the audio from the media player. - `false`: Do not publish the audio from the media player.

    • publishMediaPlayerVideoTrack

      public Boolean publishMediaPlayerVideoTrack
      Whether to publish the video from the media player: - `true`: Publish the video from the media player. - `false`: Do not publish the video from the media player.

    • publishTranscodedVideoTrack

      public Boolean 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.

    • publishMixedAudioTrack

      public Boolean publishMixedAudioTrack
      Whether to publish the mixed audio track: - `true`: Publish the mixed audio track. - `false`: Do not publish the mixed audio track.

    • publishLipSyncTrack

      public Boolean publishLipSyncTrack
      Whether to publish the video track processed by the speech driven extension: - `true`: Publish the video track processed by the speech driven extension. - `false`: (Default) Do not publish the video track processed by the speech driven extension.

    • autoSubscribeAudio

      public Boolean autoSubscribeAudio
      Whether to automatically subscribe to all remote audio streams when the user joins a channel: - `true`: Subscribe to all remote audio streams. - `false`: Do not automatically subscribe to any remote audio streams.

    • autoSubscribeVideo

      public Boolean autoSubscribeVideo
      Whether to automatically subscribe to all remote video streams when the user joins the channel: - `true`: Subscribe to all remote video streams. - `false`: Do not automatically subscribe to any remote video streams.

    • enableAudioRecordingOrPlayout

      public Boolean enableAudioRecordingOrPlayout
      Whether to enable audio capturing or playback: - `true`: Enable audio capturing or playback. - `false`: Do not enable audio capturing or playback.

    • publishMediaPlayerId

      public Integer publishMediaPlayerId
      The ID of the media player to be published. The default value is 0.

    • clientRoleType

      public Integer clientRoleType
      The user role: - CLIENT_ROLE_BROADCASTER (1): Host. - CLIENT_ROLE_AUDIENCE (2): Audience.

    • audienceLatencyLevel

      public Integer audienceLatencyLevel
      The latency level of an audience member in interactive live streaming. - AUDIENCE_LATENCY_LEVEL_LOW_LATENCY (1): Low latency. - AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY (2): (Default) Ultra low latency.

    • defaultVideoStreamType

      public Integer defaultVideoStreamType
      The default video-stream type: - VIDEO_STREAM_HIGH (0): High-quality stream, that is, a high-resolution and high-bitrate video stream. - VIDEO_STREAM_LOW (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.

    • channelProfile

      public Integer channelProfile
      The channel profile. - CHANNEL_PROFILE_COMMUNICATION (0): Communication. Agora recommends using the live streaming profile for a better audio and video experience. - CHANNEL_PROFILE_LIVE_BROADCASTING (1): (Default) Live streaming. - CHANNEL_PROFILE_GAME (2): Gaming. Deprecated: Use CHANNEL_PROFILE_LIVE_BROADCASTING instead. - CHANNEL_PROFILE_CLOUD_GAMING (3): Interaction. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users. Deprecated: Use CHANNEL_PROFILE_LIVE_BROADCASTING instead.

    • audioDelayMs

      public Integer audioDelayMs
      Delay (in milliseconds) for sending audio frames. You can use this parameter to set the delay of the audio frames that need to be sent, to ensure audio and video synchronization. To switch off the delay, set the value to 0.

    • mediaPlayerAudioDelayMs

      public Integer 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.

    • token

      public String token
      (Optional) The token generated on your server for authentication.

    • enableBuiltInMediaEncryption

      public Boolean enableBuiltInMediaEncryption
      Enable media packet encryption. It will be ignored when calling function updateChannelMediaOptions(). - true: Enable media packet encryption. - false: (Default) Do not Enable media packet encryption.

    • publishRhythmPlayerTrack

      public Boolean publishRhythmPlayerTrack
      Whether to publish the sound of a metronome to remote users: - `true`: Publish processed audio frames. Both the local user and remote users can hear the metronome. - `false`: Do not publish the sound of the metronome. Only the local user can hear the metronome.

    • isInteractiveAudience

      public Boolean isInteractiveAudience
      Whether to enable interactive mode: - `true`: Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency. - `false`:Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.

    • customVideoTrackId

      public Integer customVideoTrackId
      The video track ID returned by calling the `createCustomVideoTrack` method. The default value is 0.

    • isAudioFilterable

      public Boolean isAudioFilterable
      Whether the audio stream being published is filtered according to the volume algorithm: - `true`: The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect. - `false`: The audio stream is not filtered.

    • startPreview

      public Boolean startPreview
      Determines whether to start preview when join channel if canvas have been set. - true: (Default) Start preview when join channel. - false: Do not start preview.

    • parameters

      public String parameters
      Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.

    • enableMultipath

      public Boolean enableMultipath
      Whether to enable multiple transmisssion paths: - `true`: Enable multiple transmisssion path. - `false`: Dsiable multiple transmisssion path.
      Since:
      4.6.0

    • uplinkMultipathMode

      public Integer uplinkMultipathMode
      Uplink transmission mode. See `MultipathMode`.
      Since:
      4.6.0

    • downlinkMultipathMode

      public Integer downlinkMultipathMode
      Downlink transmission mode. See `MultipathMode`.
      Since:
      4.6.0

    • preferMultipathType

      public Integer preferMultipathType
      Preferred type of transmission path. See `MultipathType`.
      Since:
      4.6.0

  • Constructor Details

    • ChannelMediaOptions

      public ChannelMediaOptions()

    • ChannelMediaOptions

      public ChannelMediaOptions(Integer clientRoleType)

  • Method Details

    • isPublishCameraTrack

      public Boolean isPublishCameraTrack()

    • isPublishSecondaryCameraTrack

      public Boolean isPublishSecondaryCameraTrack()

    • isPublishThirdCameraTrack

      public Boolean isPublishThirdCameraTrack()

    • isPublishFourthCameraTrack

      public Boolean isPublishFourthCameraTrack()

    • isPublishScreenCaptureVideo

      public Boolean isPublishScreenCaptureVideo()

    • isPublishScreenCaptureAudio

      public Boolean isPublishScreenCaptureAudio()

    • isPublishCustomAudioTrack

      public Boolean isPublishCustomAudioTrack()

    • isPublishCustomVideoTrack

      public Boolean isPublishCustomVideoTrack()

    • isPublishEncodedVideoTrack

      public Boolean isPublishEncodedVideoTrack()

    • isPublishMediaPlayerAudioTrack

      public Boolean isPublishMediaPlayerAudioTrack()

    • isPublishMediaPlayerVideoTrack

      public Boolean isPublishMediaPlayerVideoTrack()

    • isPublishTranscodedVideoTrack

      public Boolean isPublishTranscodedVideoTrack()

    • isPublishMixedAudioTrack

      public Boolean isPublishMixedAudioTrack()

    • isPublishLipSyncTrack

      public Boolean isPublishLipSyncTrack()

    • getPublishMediaPlayerId

      public Integer getPublishMediaPlayerId()

    • isPublishMicrophoneTrack

      public Boolean isPublishMicrophoneTrack()

    • isAutoSubscribeAudio

      public Boolean isAutoSubscribeAudio()

    • isAutoSubscribeVideo

      public Boolean isAutoSubscribeVideo()

    • isStartPreview

      public Boolean isStartPreview()

    • isEnableAudioRecordingOrPlayout

      public Boolean isEnableAudioRecordingOrPlayout()

    • getClientRoleType

      public Integer getClientRoleType()

    • getAudienceLatencyLevel

      public Integer getAudienceLatencyLevel()

    • getDefaultVideoStreamType

      public Integer getDefaultVideoStreamType()

    • getChannelProfile

      public Integer getChannelProfile()

    • getAudioDelayMs

      public Integer getAudioDelayMs()

    • getMediaPlayerAudioDelayMs

      public Integer getMediaPlayerAudioDelayMs()

    • getToken

      public String getToken()

    • isEnableBuiltInMediaEncryption

      public Boolean isEnableBuiltInMediaEncryption()

    • getPublishRhythmPlayerTrack

      public Boolean getPublishRhythmPlayerTrack()

    • getIsAudioFilterable

      public Boolean getIsAudioFilterable()

    • getPublishCustomAudioTrackId

      public Integer getPublishCustomAudioTrackId()

    • getCustomVideoTrackId

      public Integer getCustomVideoTrackId()

    • isInteractiveAudience

      public Boolean isInteractiveAudience()

    • getParameters

      public String getParameters()

    • isEnableMultipath

      public Boolean isEnableMultipath()

    • getUplinkMultipathMode

      public Integer getUplinkMultipathMode()

    • getDownlinkMultipathMode

      public Integer getDownlinkMultipathMode()

    • getPreferMultipathType

      public Integer getPreferMultipathType()

    • toString

      public String toString()
      Overrides:
      toString in class Object