Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Properties | |
BOOL | publishCameraTrack |
BOOL | publishSecondaryCameraTrack |
BOOL | publishMicrophoneTrack |
BOOL | publishScreenCaptureVideo |
BOOL | publishScreenCaptureAudio |
BOOL | publishCustomAudioTrack |
NSInteger | publishCustomAudioSourceId |
BOOL | publishCustomAudioTrackEnableAec |
BOOL | publishDirectCustomAudioTrack |
BOOL | publishCustomAudioTrackAec |
BOOL | publishCustomVideoTrack |
BOOL | publishEncodedVideoTrack |
BOOL | publishMediaPlayerAudioTrack |
BOOL | publishMediaPlayerVideoTrack |
BOOL | publishTrancodedVideoTrack |
BOOL | autoSubscribeAudio |
BOOL | autoSubscribeVideo |
BOOL | enableAudioRecordingOrPlayout |
NSInteger | publishMediaPlayerId |
AgoraClientRole | clientRoleType |
AgoraAudienceLatencyLevelType | audienceLatencyLevel |
AgoraVideoStreamType | defaultVideoStreamType |
AgoraChannelProfile | channelProfile |
NSInteger | audioDelayMs |
NSInteger | mediaPlayerAudioDelayMs |
NSString *_Nullable | token |
BOOL | enableBuiltInMediaEncryption |
BOOL | publishRhythmPlayerTrack |
BOOL | isInteractiveAudience |
NSInteger | customVideoTrackId |
BOOL | isAudioFilterable |
The channel media options.
|
readwritenonatomicassign |
Determines whether to publish the video of the camera track.
YES
: (Default) Publish the video track of the camera capturer.NO
: Do not publish the video track of the camera capturer.
|
readwritenonatomicassign |
Determines whether to publish the video of the secondary camera track.
YES
: Publish the video track of the secondary camera capturer.NO
: (Default) Do not publish the video track of the secondary camera capturer.
|
readwritenonatomicassign |
Determines whether to publish the recorded audio of microphone.
YES
: (Default) Publish the recorded audio of microphone.NO
: Do not publish the recorded audio of microphone.
|
readwritenonatomicassign |
Determines whether to publish the video of the screen capturer.
YES
: Publish the video track of the screen capturer.NO
: (Default) Do not publish the video track of the screen capturer.
|
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 |
Determines whether to publish the audio of the custom audio track.
YES
: Publish the audio of the custom audio track.NO
: (Default) Do not publish the audio of the custom audio track.
|
readwritenonatomicassign |
The source id of the custom audio, default is 0.
|
readwritenonatomicassign |
Determines whether to enable AEC when publish custom audio track.
YES
: Enable AEC.NO
: (Default) Do not enable AEC.
|
readwritenonatomicassign |
Determines whether to publish custom audio track of microphone source.
YES
: Publish custom audio track of microphone source.NO
: (Default) Do not publish custom audio track of microphone source.
|
readwritenonatomicassign |
Determines whether to publish AEC custom audio track.
YES
: Publish AEC track.NO
: (Default) Do not publish AEC track.
|
readwritenonatomicassign |
Determines whether to publish the video of the custom video track.
YES
: Publish the video of the custom video track.NO
: (Default) Do not publish the video of the custom video track.
|
readwritenonatomicassign |
Determines whether to publish the video of the encoded video track.
YES
: Publish the video of the encoded video track.NO
: (Default) Do not publish the video of the encoded video track.
|
readwritenonatomicassign |
Determines whether to publish the audio track of media player.
YES
: Publish the audio track of media player.NO
: (Default) Do not publish the audio track of media player.
|
readwritenonatomicassign |
Determines whether to publish the video track of media player source.
YES
: Publish the video track of media player source.NO
: (Default) Do not publish the video track of media player source.
|
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 |
Determines whether to subscribe all remote audio streams automatically. This property replaces calling AgoraRtcEngineKit.setDefaultMuteAllRemoteAudioStreams: setDefaultMuteAllRemoteAudioStreams before joining a channel.
YES
: (Default) Subscribe all remote audio streams automatically.NO
: Do not subscribe any remote audio stream automatically.
|
readwritenonatomicassign |
Determines whether to subscribe all remote video streams automatically. This property replaces calling setDefaultMuteAllRemoteVideoStreams: (AgoraRtcEngineKit) setDefaultMuteAllRemoteVideoStreams before joining a channel.
YES
: (Default) Subscribe all remote video streams automatically.NO
: Do not subscribe any remote video stream automatically.
|
readwritenonatomicassign |
Determines whether to enable audio recording or playout.
YES
: (Default) It's used to publish audio and mix microphone, or subscribe audio and playout.NO
: It's used to publish extenal audio frame only without mixing microphone, or no need audio device to playout audio either.
|
readwritenonatomicassign |
Determines which media player source should be published. This parameter get from function getMediaPlayerId() of AgoraMediaPlayer.
|
readwritenonatomicassign |
The client role type: AgoraClientRole. Default is AgoraClientRoleAudience.
|
readwritenonatomicassign |
The audience latency level type: AgoraAudienceLatencyLevelType. Default is AgoraAudienceLatencyLevelUltraLowLatency.
|
readwritenonatomicassign |
The default video stream type: AgoraVideoStreamType. Default is AgoraVideoStreamTypeHigh.
|
readwritenonatomicassign |
The channel profile: AgoraChannelProfile. Default is AgoraChannelProfileLiveBroadcasting.
|
readwritenonatomicassign |
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.
|
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 |
The token to be renewed.
|
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 |
Determines whether to publish the sound of the rhythm player to remote users.
|
readwritenonatomicassign |
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.
YES
: Enable low lentancy and smooth video when joining as an audience.NO
: (default) Use default settings for audience role.
|
readwritenonatomicassign |
The custom video track id which will used to publish or preview.
|
readwritenonatomicassign |
Determines whether local audio stream can be filtered.
YES
: (Default) Can be filtered when audio level is low.NO
: Do not filter this audio stream.