|
Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Agora supports publishing multiple audio streams and one video stream at the same time and in the same AgoraRtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as YES at the same time, but only one of publishCameraTrack, publishScreenCaptureVideo (iOS)/publishScreenTrack (macOS), publishCustomVideoTrack, or publishEncodedVideoTrack can be set as YES.
|
readwritenonatomicassign |
Whether to publish the video captured by the camera:
YES: Publish the video captured by the camera.NO: Do not publish the video captured by the camera.
|
readwritenonatomicassign |
Whether to publish the video captured by the second camera:
YES: Publish the video captured by the second camera.NO: Do not publish the video captured by the second camera.
|
readwritenonatomicassign |
Whether to publish the audio captured by the microphone:
YES: Publish the audio captured by the microphone.NO: Do not publish the audio captured by the microphone.
|
readwritenonatomicassign |
Determines whether to publish the audio of the screen capturer.
YES: Publish the audio track of the screen capturer.NO: (Default) Do not publish the audio track of the screen capturer.
|
readwritenonatomicassign |
(iOS only) Whether to publish the video captured from the screen:
YES: Publish the video captured from the screen.NO: Do not publish the video captured from the screen. publishScreenTrack to publishScreenCaptureVideo.
|
readwritenonatomicassign |
Whether to publish the audio captured from a custom source:
YES: Publish the audio captured from the custom source.NO: Do not publish the captured audio from a custom source.
|
readwritenonatomicassign |
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:config: method.
|
readwritenonatomicassign |
Whether to publish the video captured from a custom source:
YES: Publish the video captured from the custom source.NO: Do not publish the captured video from a custom source.
|
readwritenonatomicassign |
Whether to publish the encoded video:
YES: Publish the encoded video.NO: Do not publish the encoded video.
|
readwritenonatomicassign |
Whether to publish the audio from the media player:
YES: Publish the audio from the media player.NO: Do not publish the audio from the media player.
|
readwritenonatomicassign |
Whether to publish the video from the media player:
YES: Publish the video from the media player.NO: Do not publish the video from the media player.
|
readwritenonatomicassign |
Determines whether to publish the local transcoded video track.
YES: Publish the video track of local transcoded video track.NO: (Default) Do not publish the local transcoded video track.
|
readwritenonatomicassign |
Whether to publish the mixed audio track:
YES: Publish the mixed audio track.NO: Do not publish the mixed audio track.
|
readwritenonatomicassign |
Whether to publish the video track processed by the speech driven extension:
YES: Publish the video track processed by the speech driven extension.NO: (Default) Do not publish the video track processed by the speech driven extension.
|
readwritenonatomicassign |
Whether to automatically subscribe to all remote audio streams when the user joins a channel:
YES: Subscribe to all remote audio streams.NO: Do not automatically subscribe to any remote audio streams.
|
readwritenonatomicassign |
Whether to automatically subscribe to all remote video streams when the user joins the channel:
YES: Subscribe to all remote video streams.NO: Do not automatically subscribe to any remote video streams.
|
readwritenonatomicassign |
Whether to enable audio capturing or playback:
YES: Enable audio capturing or playback.NO: Do not enable audio capturing or playback. YES.
|
readwritenonatomicassign |
The ID of the media player to be published. The default value is 0.
|
readwritenonatomicassign |
The user role. See AgoraClientRole.
|
readwritenonatomicassign |
The latency level of an audience member in interactive live streaming. See AgoraAudienceLatencyLevelType.
|
readwritenonatomicassign |
The default video-stream type. See AgoraVideoStreamType.
|
readwritenonatomicassign |
The channel profile. See AgoraChannelProfile.
|
readwritenonatomicassign |
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.
|
readwritenonatomicassign |
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.
|
readwritenonatomiccopy |
(Optional) The token generated on your server for authentication.
updateChannelWithMediaOptions: or updateChannelExWithMediaOptions:connection:.sharedEngineWithConfig:delegate: method for initializing the RTC engine, and those used by the joinChannelByToken:channelId:uid:mediaOptions:joinSuccess: and joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: methods for joining the channel.
|
readwritenonatomicassign |
Enable media packet encryption. It will be ignored when calling function updateChannelMediaOptions().
YES: Enable media packet encryption.NO: (Default) Do not Enable media packet encryption.
|
readwritenonatomicassign |
Whether to publish the sound of a metronome to remote users:
YES: Publish processed audio frames. Both the local user and remote users can hear the metronome.NO: Do not publish the sound of the metronome. Only the local user can hear the metronome.
|
readwritenonatomicassign |
Whether to enable interactive mode:
YES: 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.NO:Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings. joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: method to join the other host's channel as an audience member, and set isInteractiveAudience to YES.AgoraClientRoleAudience.
|
readwritenonatomicassign |
The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
|
readwritenonatomicassign |
Whether the audio stream being published is filtered according to the volume algorithm:
YES: The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.NO: The audio stream is not filtered. support@agora.io.
|
readwritenonatomiccopy |
Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options. @technical preview
|
readwritenonatomicassign |
Whether to enable multiple transmisssion paths:
YES: Enable multiple transmisssion path.NO: Dsiable multiple transmisssion path.
|
readwritenonatomicassign |
Uplink transmission mode. See AgoraMultipathMode.
enableMultipath is set to YES.
|
readwritenonatomicassign |
Downlink transmission mode. See AgoraMultipathMode.
enableMultipath is set to YES.
|
readwritenonatomicassign |
Preferred type of transmission path. See AgoraMultipathType.
enableMultipath is set to YES. 1.8.20