ChannelApi class

Constructors

ChannelApi({BinaryMessenger? binaryMessenger})

Constructor for ChannelApi. The binaryMessenger named argument is available for dependency injection. If it is left null, the default BinaryMessenger will be used which routes to the host platform.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addLiveStreamTask(String arg_channelTag, AddOrUpdateLiveStreamTaskRequest arg_request) → Future<int>

adjustLoopBackRecordingSignalVolume(String arg_channelTag, int arg_volume) → Future<int>

adjustUserPlaybackSignalVolume(String arg_channelTag, AdjustUserPlaybackSignalVolumeRequest arg_request) → Future<int>

clearStatsEventCallback(String arg_channelTag) → Future<int>

enableAudioVolumeIndication(String arg_channelTag, EnableAudioVolumeIndicationRequest arg_request) → Future<int>

enableEncryption(String arg_channelTag, EnableEncryptionRequest arg_request) → Future<int>

enableLocalAudio(String arg_channelTag, bool arg_enable) → Future<int>

enableLocalData(String arg_channelTag, bool arg_enabled) → Future<int>

enableLocalSubStreamAudio(String arg_channelTag, bool arg_enable) → Future<int>

enableLocalVideo(String arg_channelTag, EnableLocalVideoRequest arg_request) → Future<int>

enableLoopbackRecording(String arg_channelTag, bool arg_enable) → Future<int>

enableMediaPub(String arg_channelTag, int arg_mediaType, bool arg_enable) → Future<int>

enableSpatializer(String arg_channelTag, bool arg_enable, bool arg_applyToTeam) → Future<int>

enableSpatializerRoomEffects(String arg_channelTag, bool arg_enable) → Future<int>

getChannelName(String arg_channelTag) → Future<String>

getConnectionState(String arg_channelTag) → Future<int>

getFeatureSupportedType(String arg_channelTag, int arg_type) → Future<int>

joinChannel(String arg_channelTag, JoinChannelRequest arg_request) → Future<int>

leaveChannel(String arg_channelTag) → Future<int>

muteLocalAudioStream(String arg_channelTag, bool arg_mute) → Future<int>

muteLocalVideoStream(String arg_channelTag, bool arg_mute, int arg_streamType) → Future<int>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pushExternalVideoFrame(String arg_channelTag, int arg_streamType, VideoFrame arg_frame) → Future<int>

release(String arg_channelTag) → Future<int>

removeLiveStreamTask(String arg_channelTag, DeleteLiveStreamTaskRequest arg_request) → Future<int>

reportCustomEvent(String arg_channelTag, ReportCustomEventRequest arg_request) → Future<int>

sendData(String arg_channelTag, DataExternalFrame arg_frame) → Future<int>

sendSEIMsg(String arg_channelTag, SendSEIMsgRequest arg_request) → Future<int>

setAudioRecvRange(String arg_channelTag, int arg_audibleDistance, int arg_conversationalDistance, int arg_rollOffMode) → Future<int>

setAudioSubscribeOnlyBy(String arg_channelTag, SetAudioSubscribeOnlyByRequest arg_request) → Future<int>

setCameraCaptureConfig(String arg_channelTag, SetCameraCaptureConfigRequest arg_request) → Future<int>

setChannelProfile(String arg_channelTag, int arg_channelProfile) → Future<int>

setClientRole(String arg_channelTag, int arg_role) → Future<int>

setExternalVideoSource(String arg_channelTag, int arg_streamType, bool arg_enable) → Future<int>

setLocalMediaPriority(String arg_channelTag, SetLocalMediaPriorityRequest arg_request) → Future<int>

setLocalPublishFallbackOption(String arg_channelTag, int arg_option) → Future<int>

setLocalVideoConfig(String arg_channelTag, SetLocalVideoConfigRequest arg_request) → Future<int>

setRangeAudioMode(String arg_channelTag, int arg_audioMode) → Future<int>

setRangeAudioTeamID(String arg_channelTag, int arg_teamID) → Future<int>

setRemoteHighPriorityAudioStream(String arg_channelTag, SetRemoteHighPriorityAudioStreamRequest arg_request) → Future<int>

setRemoteSubscribeFallbackOption(String arg_channelTag, int arg_option) → Future<int>

setSpatializerRenderMode(String arg_channelTag, int arg_renderMode) → Future<int>

setSpatializerRoomProperty(String arg_channelTag, SpatializerRoomProperty arg_property) → Future<int>

setStatsEventCallback(String arg_channelTag) → Future<int>

setSubscribeAudioAllowlist(String arg_channelTag, List<int?> arg_uidArray) → Future<int>

setSubscribeAudioBlocklist(String arg_channelTag, List<int?> arg_uidArray, int arg_streamType) → Future<int>

setUpSpatializer(String arg_channelTag) → Future<int>

setVideoStreamLayerCount(String arg_channelTag, int arg_layerCount) → Future<int>

startChannelMediaRelay(String arg_channelTag, StartOrUpdateChannelMediaRelayRequest arg_request) → Future<int>

startScreenCapture(String arg_channelTag, StartScreenCaptureRequest arg_request) → Future<int>

stopChannelMediaRelay(String arg_channelTag) → Future<int>

stopScreenCapture(String arg_channelTag) → Future<int>

subscribeAllRemoteAudio(String arg_channelTag, bool arg_subscribe) → Future<int>

subscribeRemoteAudio(String arg_channelTag, int arg_uid, bool arg_subscribe) → Future<int>

subscribeRemoteData(String arg_channelTag, bool arg_subscribe, int arg_userID) → Future<int>

subscribeRemoteSubAudio(String arg_channelTag, int arg_uid, bool arg_subscribe) → Future<int>

subscribeRemoteSubVideoStream(String arg_channelTag, int arg_uid, bool arg_subscribe) → Future<int>

subscribeRemoteVideoStream(String arg_channelTag, SubscribeRemoteVideoStreamRequest arg_request) → Future<int>

switchCamera(String arg_channelTag) → Future<int>

switchCameraWithPosition(String arg_channelTag, int arg_position) → Future<int>

takeLocalSnapshot(String arg_channelTag, int arg_streamType, String arg_path) → Future<int>

takeRemoteSnapshot(String arg_channelTag, int arg_uid, int arg_streamType, String arg_path) → Future<int>

toString() → String

A string representation of this object.

inherited

updateChannelMediaRelay(String arg_channelTag, StartOrUpdateChannelMediaRelayRequest arg_request) → Future<int>

updateLiveStreamTask(String arg_channelTag, AddOrUpdateLiveStreamTaskRequest arg_request) → Future<int>

updateSelfPosition(String arg_channelTag, PositionInfo arg_positionInfo) → Future<int>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

codec → const MessageCodec<Object?>