ChannelMediaOptions

The channel media options.

export class ChannelMediaOptions {

      publishCameraTrack?: boolean;

      publishSecondaryCameraTrack?: boolean;

      publishThirdCameraTrack?: boolean;

      publishFourthCameraTrack?: boolean;

      publishMicrophoneTrack?: boolean;

      publishScreenTrack?: boolean;

      publishSecondaryScreenTrack?: boolean;

      publishThirdScreenTrack?: boolean;

      publishFourthScreenTrack?: boolean;

      publishCustomAudioTrack?: boolean;

      publishCustomAudioTrackId?: number;

      publishCustomVideoTrack?: boolean;

      publishEncodedVideoTrack?: boolean;

      publishMediaPlayerAudioTrack?: boolean;

      publishMediaPlayerVideoTrack?: boolean;

      publishTranscodedVideoTrack?: boolean;

      publishLipSyncTrack?: boolean;

      autoSubscribeAudio?: boolean;

      autoSubscribeVideo?: boolean;

      enableAudioRecordingOrPlayout?: boolean;

      publishMediaPlayerId?: number;

      clientRoleType?: ClientRoleType;

      audienceLatencyLevel?: AudienceLatencyLevelType;

      defaultVideoStreamType?: VideoStreamType;

      channelProfile?: ChannelProfileType;

      token?: string;

      enableBuiltInMediaEncryption?: boolean;

      publishRhythmPlayerTrack?: boolean;

      isInteractiveAudience?: boolean;

      customVideoTrackId?: number;

      isAudioFilterable?: boolean;
    }
Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true.
Attention: Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.

Attributes

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
Whether to publish the video captured by the second camera:
  • true: Publish the video captured by the second camera.
  • false: Do not publish the video captured by the second camera.
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.
Note:
  • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
  • If you set this parameter as false, SDK turns off microphone capturing.
  • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as true.
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
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.
publishScreenTrack
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.
publishSecondaryScreenTrack
Whether to publish the video captured from the second screen:
  • true: Publish the video captured from the second screen.
  • false: Do not publish the video captured from the second screen.
publishThirdScreenTrack
Whether to publish the video captured from the third screen:
  • true: Publish the captured video from the third screen.
  • false: Do not publish the video captured from the third screen.

publishFourthScreenTrack
Whether to publish the video captured from the fourth screen:
  • true: Publish the captured video from the fourth screen.
  • false: Do not publish the video captured from the fourth screen.

publishTranscodedVideoTrack
Whether to publish the local transcoded video:
  • true: Publish the local transcoded video.
  • false: Do not publish the local transcoded video.
publishMixedAudioTrack
Whether to publish the mixed audio track:
  • true: Publish the mixed audio track.
  • false: Do not publish the mixed audio track.
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.
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
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
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
Whether to publish the encoded video:
  • true: Publish the encoded video.
  • false: Do not publish the encoded video.
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
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.
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
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
Whether to enable audio capturing or playback:
  • true: Enable audio capturing or playback.
  • false: Do not enable audio capturing or playback.
Note: If you need to publish the audio streams captured by your microphone, ensure this parameter is set as true.
publishMediaPlayerId
The ID of the media player to be published. The default value is 0.
clientRoleType
The user role. See ClientRoleType.
audienceLatencyLevel
The latency level of an audience member in interactive live streaming. See AudienceLatencyLevelType.
defaultVideoStreamType

The default video-stream type. See VideoStreamType.

channelProfile

The channel profile. See ChannelProfileType.

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.

token

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

Attention:
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
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.
Attention:
  • This parameter only applies to co-streaming scenarios. The cohosts need to call the joinChannelEx method to join the other host's channel as an audience member, and set isInteractiveAudience to true.
  • This parameter takes effect only when the user role is ClientRoleAudience.
customVideoTrackId
The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
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.
Attention: If you need to enable this function, contact support@agora.io.