NERoomRtcController class Null safety

Inheritance

Constructors

NERoomRtcController()

Properties

hashCode int
The hash code for this object.
read-only, inherited
isSupported bool
Get whether the feature is supported.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

addAttachment(String name, dynamic attachment) → void
inherited
addBeautyFilter(String path) Future<VoidResult>
add filter effects by calling addBeautyFilter and set the filter intensity using setBeautyFilterLevel. The filter effect can be overlayed with the global beauty effect, but multiple filters cannot apply at the same time. To replace filters, call this API repeatedly to use the new filter resource. To add a filter, specify the path where the filter model is located using the path parameter. An absolute path on the SD card or a relative path in the asset directory are supported. The level parameter is used to specify the filter intensity and the value range is 0,1. The default value is 0.5. The greater the value, the greater the filter intensity. You can customize the beauty intensity according to business needs. @param path The path where the filter resource or model is located. /// An absolute path on the SD card or a relative path in the asset directory are supported. SD card: "/storage/emulated/0/Android/data/com.xxx/files/filter_portrait/filter_style_FN1". asset: "2D/bunny"。 @return callback 0: success. Others: failure /
inherited
addBeautySticker(String path) Future<VoidResult>
Add a sticker effect. This interface is used to load sticker resources and add corresponding sticker effects. To replace stickers, call this API repeatedly to use new sticker resources. Before using custom beauty effects such as filters, stickers, and makeup, you need to prepare the corresponding beauty resources or models. The sticker effect can be overlayed with the global beauty effect, filters, and makeups, but multiple stickers cannot apply at the same time. @param path The path where the sticker resource is located. /// An absolute path on the SD card or a relative path in the asset directory are supported. SD card: "/storage/emulated/0/Android/data/com.xxx/files/filter_portrait/filter_style_FN1" asset: "2D/bunny" @return 0: success. Others: failure /
inherited
adjustUserPlaybackSignalVolume(String userUuid, int volume) Future<VoidResult>
Set the playback volume of a remote member. userUuid user ID volume Volume, 0-100
clearAttachments() → void
inherited
disableEarBack() Future<VoidResult>
Turn off the in-ear monitor
enableAudioVolumeIndication(bool enable, int interval) Future<VoidResult>
Enables the volume indication. The method allows the SDK to report to the app the information about the volume of the user that publishes local streams and the remote users (up to 3 users) with the highest instantaneous volume. The SDK sends to the app the current speaker and the volume. After enabling this method, as long as one or more users publish streams, regardless of whether users speak the SDK triggers the onRemoteAudioVolumeIndication callback based on the preset time intervals. enable specifies whether the speaker volume is prompted.. interval specifies the time interval at which volume prompt. Unit: milliseconds. The value must be the multiples of 100 milliseconds. We recommend that you set the value 200 milliseconds or more.
enableBeauty(bool isOpenBeauty) Future<VoidResult>
Enable the beauty function, the setting will not be reset if your leave the channel. The interface is used when the beauty needs to be temporarily disabled. For example, comparing the effects before and after the beauty enabled @param isOpenBeauty true: enable beauty effect, false: disable the beauty effect @return callback 0: success. Others: failure /
inherited
enableEarBack(int volume) Future<VoidResult>
Turn on the in-ear monitor volume volume of the in-ear monitor, 0-100
enableVirtualBackground(bool enabled, NERoomVirtualBackgroundSource backgroundSource) Future<VoidResult>
inherited
getAttachment(String name) → dynamic
inherited
getScreenSharingUserUuid() String?
get UserUuid that is sharing screen
isSpeakerphoneOn() Future<bool>
Check whether the speaker phone is turned on
joinRtcChannel() Future<VoidResult>
Joins an RTC room
leaveRtcChannel() Future<VoidResult>
Leave an RTC room
muteMemberAudio(String uuid) Future<VoidResult>
Attempt to mute member audios, permission verification will be performed
muteMemberVideo(String uuid) Future<VoidResult>
Attempt to mute member videos, permission verification will be performed
muteMyAudio() Future<VoidResult>
Mute the local audio
muteMyVideo() Future<VoidResult>
Mute the local video
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
playEffect(int id, NECreateAudioEffectOption option) Future<VoidResult>
Playback the audio effect option Audio effect parameter
removeAttachment(String name) → void
inherited
removeBeautyFilter() Future<VoidResult>
When the filter effect is not needed, call removeBeautyFilter to remove the filter. /
inherited
removeBeautySticker() Future<VoidResult>
Remove a sticker. @return 0: success. Others: failure
inherited
setAudioMixingPlaybackVolume(int volume) Future<VoidResult>
Sets the playback volume of a mixing audio stream. volume volume, 0-100
setAudioMixingSendVolume(int volume) Future<VoidResult>
Sets the publishing volume of a mixing audio stream. volume volume, 0-100
setBeautyEffect(NERoomBeautyEffectType beautyType, double level) Future<VoidResult>
https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI?platformId=50002#Global beauty effect Enable the specified beauty effect and set the beauty intensity by calling setBeautyEffect. @param beautyType specifies the beauty effect. Beauty effects such as whitening and polishing are supported. For specific enumeration values, see the table below. NERoomBeautyEffectType @param level specifies the beauty intensity. The value range is 0,1, and the default values of various beauty effects are different. The greater the value, the greater the beauty intensity. You can customize the beauty intensity according to business needs. @return callback 0: success. Others: failure /
inherited
setBeautyFilterLevel(double level) Future<VoidResult>
Sets the filter intensity. The greater the value, the greater the filter intensity. You can customize the filter intensity according to business needs. The filter intensity setting takes effect in real time. After changing the filter, the filter intensity does not change. If you need to adjust it, you can call this interface again to reset the filter intensity. @param level Filter intensity. Value range 0 - 1. The default value is 0.5 @return 0: success. Others: failure /
inherited
setEffectPlaybackVolume(int id, int volume) Future<VoidResult>
Set the playback volume for an audio effect. id Audio effect ID volume volume, 0-100
setEffectSendVolume(int id, int volume) Future<VoidResult>
Set the publishing volume of an audio effect id Audio effect ID volume volume, 0-100
setSpeakerphoneOn(bool on) Future<VoidResult>
Turn on or off the speakerphone.
startAudioDump(NEAudioDumpType type) Future<VoidResult>
Open an audio dump
startAudioMixing(NECreateAudioMixingOption option) Future<VoidResult>
Start audio mixing option parameter for audio mixing
startBeauty() Future<VoidResult>
example: https://doc.yunxin.163.com/docs/jcyOTA0ODM/DQ1OTY0NjI?platformId=50002#sample code Enable the beauty effect module. Before starting the video, enable the beauty module by calling startBeauty. After the beauty effect is enabled, you can apply global beauty, filters and other beauty effects. Start the beauty engine by calling this interface. If you no longer need to use the beauty function, you can disabel the beauty module by calling stopBeauty, destroy the beauty engine and release resources. After the beauty function module is enabled, the global beauty effect is enabled by default. You can also set beauty, filter and other effects using setBeautyEffect or other filter and sticker related interfaces. @return callback 0: success. Others: failure /
inherited
startRtcChannelMediaRelay() Future<VoidResult>
Start relaying media streams across rooms
startScreenShare({String? iosAppGroup}) Future<VoidResult>
Start screen sharing
stopAllEffects() Future<VoidResult>
Stop all audio effects
stopAudioDump() Future<VoidResult>
Stop creating an audio dump
stopAudioMixing() Future<VoidResult>
Stop audio mixing
stopBeauty() → dynamic
inherited
stopEffect(int id) Future<VoidResult>
Stop audio effect id Audio effect ID
stopMemberScreenShare(String uuid) Future<VoidResult>
Attempt to stop screen sharing, permission verification will be performed.
stopRtcChannelMediaRelay() Future<VoidResult>
Stops media stream relay across rooms
stopScreenShare() Future<VoidResult>
Stop screen sharing
subscribeRemoteVideoStream(String userUuid, NEVideoStreamType streamType) Future<VoidResult>
Subscribes to video streams from specified remote users userUuid user ID subscribe whether subscribing to the video stream is canceled
subscribeRemoteVideoSubStream(String userUuid) Future<VoidResult>
Subscribes to video substreams from specified remote users userUuid user ID
switchCamera() Future<VoidResult>
Wwitch the camera
inherited
toString() String
A string representation of this object.
inherited
unmuteMemberAudio(String uuid) Future<VoidResult>
Attempt to unmute member audios, permission verification will be performed
unmuteMemberVideo(String uuid) Future<VoidResult>
Attempt to unmute member videos, permission verification will be performed
unmuteMyAudio() Future<VoidResult>
Unmute the local audio
unmuteMyVideo() Future<VoidResult>
Unmute the local video
unsubscribeRemoteVideoStream(String userUuid, NEVideoStreamType streamType) Future<VoidResult>
Subscribes to or unsubscribes from video substreams from specified remote users userUuid user ID subscribe whether subscribing to the video stream is canceled
unsubscribeRemoteVideoSubStream(String userUuid) Future<VoidResult>
Unsubscribes from video substreams from specified remote users userUuid user ID subscribe whether subscribing to the video stream is canceled

Operators

operator ==(Object other) bool
The equality operator.
inherited