RtcEngine class

RtcEngine 类提供了供 App 调用的主要接口方法。

Properties

• hashCode → int

  The hash code for this object. [...]

  read-only, inherited

• runtimeType → Type

  A representation of the runtime type of the object.

  read-only, inherited

Methods

• addInjectStreamUrl(String url, LiveInjectStreamConfig config) → Future

  输入在线媒体流。 [...]

• addPublishStreamUrl(String url, bool transcodingEnabled) → Future< void >

  增加旁路推流地址。 [...]

• removePublishStreamUrl(String url) → Future< void >

  删除旁路推流地址。 调用该方法后，SDK 会在本地触发 RtcEngineEventHandler.rtmpStreamingStateChanged 回调， 报告删除旁路推流地址的状态。 [...]

• adjustAudioMixingPlayoutVolume(int volume) → Future< void >

  调节音乐文件的本地播放音量。 [...]

• adjustAudioMixingPublishVolume(int volume) → Future< void >

  调节音乐文件的远端播放音量。 [...]

• adjustAudioMixingVolume(int volume) → Future< void >

  调节音乐文件的播放音量。 [...]

• adjustPlaybackSignalVolume(int volume) → Future< void >

  调节本地播放的所有远端用户音量。 [...]

• adjustRecordingSignalVolume(int volume) → Future< void >

  调节录音音量。 [...]

• adjustUserPlaybackSignalVolume(String uid, int volume) → Future< void >

  调节本地播放的指定远端用户音量。 [...]

• destroy() → Future< void >

  销毁 RtcEngine 实例。 [...]

• disableAudio() → Future< void >

  关闭音频模块。 [...]

• disableVideo() → Future< void >

  关闭视频模块。 [...]

• enableAudio() → Future< void >

  启用音频模块（默认为开启状态）。 [...]

• enableAudioVolumeIndication(int interval, int smooth, bool report_vad) → Future< void >

  启用说话者音量提示。 [...]

• enableDualStreamMode(bool enabled) → Future< void >

  开/关视频双流模式。 [...]

• enableInEarMonitoring(bool enabled) → Future< void >

  开启耳返功能。 [...]

• enableLocalAudio(bool enabled) → Future< void >

  开启/关闭本地音频采集。 [...]

• enableLocalVideo(bool enabled) → Future< void >

  开启/关闭本地视频采集。 [...]

• enableVideo() → Future< void >

  启用视频模块。 [...]

• getAudioMixingCurrentPosition() → Future < int >

  获取音乐文件的播放进度。 [...]

• getAudioMixingDuration() → Future< int >

  获取音乐文件的时长。 [...]

• getAudioMixingPlayoutVolume() → Future< int >

  获取音乐文件的本地播放音量。 [...]

• getAudioMixingPublishVolume() → Future< int >

  获取音乐文件的远端播放音量。 [...]

• getCallId() → Future< String >

  获取通话 ID。 [...]

• getCameraMaxZoomFactor() → Future< double >

  获取摄像头支持最大缩放比例。 [...]

• getConnectionState() → Future<ConnectionStateType>

  获取当前网络连接状态。

• getEffectsVolume() → Future< double >

  获取所有音效文件播放音量, 范围为 0.0,100.0。 [...]

• isCameraAutoFocusFaceModeSupported() → Future< bool >

  检测设备是否支持人脸对焦功能。 [...]

• isCameraExposurePositionSupported() → Future< bool >

  检测设备是否支持手动曝光功能。 [...]

• isCameraFocusSupported() → Future< bool >

  检测设备是否支持手动对焦功能。 [...]

• isCameraTorchSupported() → Future< bool >

  检测设备是否支持闪光灯常开。 [...]

• isCameraZoomSupported() → Future< bool >

  检测设备是否支持摄像头缩放功能。 [...]

• isSpeakerphoneEnabled() → Future< bool >

  检查扬声器状态启用状态。 [...]

• joinChannel(String token, String channelName, String optionalInfo, String optionalUid) → Future< void >

  加入频道。 [...]

• leaveChannel() → Future< void >

  离开频道。 [...]

• muteAllRemoteAudioStreams(bool muted) → Future< void >

  停止/恢复接收所有音频流。 [...]

• muteAllRemoteVideoStreams(bool muted) → Future< void >

  停止/恢复接收所有视频流。 [...]

• muteLocalAudioStream(bool muted) → Future< void >

  停止/恢复发送本地音频流。 [...]

• muteLocalVideoStream(bool muted) → Future< void >

  停止/恢复发送本地视频流。 [...]

• muteRemoteAudioStream(String uid, bool muted) → Future< void >

  停止/恢复接收指定音频流。 [...]

• muteRemoteVideoStream(String uid, bool muted) → Future< void >

  停止/恢复接收指定视频流。 [...]

• noSuchMethod invocation) → dynamic

  Invoked when a non-existent method or property is accessed. [...]inherited

• pauseAllEffects() → Future< void >

  暂停播放所有音效文件。

• pauseAudioMixing() → Future< void >

  暂停播放音乐文件及混音。 [...]

• pauseEffect(int soundId) → Future< void >

  暂停播放指定音效文件。 [...]

• playEffect(int soundId, String filePath, int loopCount, double pitch, double pan, double gain, bool publish) → Future< void >

  播放指定音效文件。 该方法播放指定的本地或在线音效文件。你可以在该方法中设置音效文件的播放次数、音调、音效的空间位置和增益，以及远端用户是否能听到该音效。 [...]

• preloadEffect(int soundId, String filePath) → Future< void >

  将音效文件预加载至内存。 [...]

• rate(String callId, int rating, {String description}) → Future< void >

  给通话评分。 [...]

• removeInjectStreamUrl(String url) → Future< void >

  删除输入的在线媒体流。 [...]

• renewToken(String token) → Future< void >

  更新 Token。 [...]

• resumeAllEffects() → Future< void >

  恢复播放所有音效文件。

• resumeAudioMixing() → Future< void >

  恢复播放音乐文件及混音。 [...]

• resumeEffect(int soundId) → Future< void >

  恢复播放指定音效文件。 [...]

• setAudioMixingPitch(int pitch) → Future< void >

  调整本地播放的音乐文件的音调。 [...]

• setAudioMixingPosition(int pos) → Future< void >

  设置音乐文件的播放位置。 [...]

• setAudioProfile(AudioProfile profile, AudioScenario scenario) → Future< void >

  设置音频编码配置。 [...]

• setCameraCapturerConfiguration(CameraCapturerConfiguration config) → Future< void >

  设置摄像头的采集偏好。 [...]

• setCameraExposurePosition(double positionXinView, double positionYinView) → Future< void >

  设置手动曝光位置。 [...]

• setCameraFocusPositionInPreview(double positionX, double positionY) → Future< void >

  设置手动对焦位置，并触发对焦。 [...]

• setCameraTorchOn(bool isOn) → Future< void >

  设置是否打开闪光灯。 [...]

• setCameraZoomFactor(double factor) → Future< void >

  设置摄像头缩放比例。 [...]

• setChannelProfile(ChannelProfile profile) → Future< void >

  设置频道场景。 [...]

• setClientRole(ClientRole role) → Future< void >

  设置直播场景下的用户角色。 [...]

• setDefaultAudioRoutetoSpeakerphone(bool defaultToSpeaker) → Future< void >

  设置默认的音频播放路由。 [...]

• setDefaultMuteAllRemoteAudioStreams(bool muted) → Future< void >

  设置是否默认接收音频流。 [...]

• setDefaultMuteAllRemoteVideoStreams(bool muted) → Future< void >

  设置是否默认接收视频流。 [...]

• setEffectsVolume(double volume) → Future< void >

  设置所有音效文件的播放音量。 [...]

• setEnableSpeakerphone(bool enabled) → Future< void >

  启用/关闭扬声器播放。 [...]

• setEventHandler(RtcEngineEventHandler handler) → void

  添加 RtcEngineEventHandler 回调事件。 [...]

• setInEarMonitoringVolume(int volume) → Future< void >

  设置耳返音量。 [...]

• setLogFile(String filePath) → Future< void >

  设置 AR SDK 输出的日志文件。 [...]

• setLogFileSize(int fileSizeInKBytes) → Future< void >

  设置 AR SDK 输出的单个日志文件大小。 [...]

• setLogFilter(LogFilter filter) → Future< void >

  设置日志输出等级 [...]

• setParameters(String parameters) → Future< void >

  通过 JSON 配置 SDK 提供技术预览或特别定制功能。 [...]

• setRemoteVideoStreamType(String uid, VideoStreamType streamType) → Future< void >

  设置订阅的视频流类型。 [...]

• setVideoEncoderConfiguration(VideoEncoderConfiguration config) → Future< void >

  设置视频编码属性。 [...]

• startAudioMixing(String filePath, bool loopback, bool replace, int cycle) → Future< void >

  开始播放音乐文件及混音。 [...]

• startAudioRecording(String filePath, AudioSampleRateType sampleRate, AudioRecordingQuality quality) → Future< void >

  开始客户端录音。 [...]

• startChannelMediaRelay(ChannelMediaRelayConfiguration channelMediaRelayConfiguration) → Future< void >

  开始跨频道媒体流转发。 [...]

• startPreview() → Future< void >

  开启视频预览。 [...]

• stopAllEffects() → Future< void >

  停止播放所有音效文件。

• stopAudioMixing() → Future< void >

  停止播放音乐文件及混音。 [...]

• stopAudioRecording() → Future< void >

  停止客户端录音。 [...]

• stopChannelMediaRelay() → Future< void >

  停止跨频道媒体流转发。 [...]

• stopEffect(int soundId) → Future< void >

  停止播放指定音效文件。 [...]

• stopPreview() → Future< void >

  停止视频预览。

• switchCamera() → Future< void >

  切换前置/后置摄像头。

• switchChannel(String token, String channelName) → Future< void >

  快速切换直播频道。 [...]

• toString() → String

  Returns a string representation of this object.inherited

• updateChannelMediaRelay(ChannelMediaRelayConfiguration channelMediaRelayConfiguration) → Future< void >

  更新媒体流转发的频道。 [...]

Operators

• operator ==(Object other) → bool

  The equality operator. [...]inherited

Static Methods

• create(String appId) → Future<RtcEngine>

  创建 RtcEngine 实例。[...]