RtcEngineKit class Null safety

RtcEngine is the main class of the PanoRtc SDK.

Mixed in types

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

annotationManager() Future<RtcAnnotationManager?>
Get annotation manager object.
callout(String phoneNo, bool bindToUser) Future<ResultCode>
Call-out a phone number.
override
createAudioMixingTask(int taskId, String filename) Future<ResultCode>
Create audio mixing task.
destroy() Future<void>
Destroy the RtcEngineKit object.
override
destroyAudioMixingTask(int taskId) Future<ResultCode>
Destroy audio mixing task.
dropCall(String phoneNo) Future<ResultCode>
dropCall the call-out or call-in.
override
getAudioDeviceVolume(AudioDeviceType type) Future<int>
Get the volume of the current audio device.
getAudioMixingCurrentTimestamp(int taskId) Future<int>
Get current timestamp.
getAudioMixingDuration(int taskId) Future<int>
Get duration of music file.
getCameraDeviceId(bool frontCamera) Future<String?>
Get camera device ID.
getPlayoutLevel() Future<int>
Get audio playout level.
getRecordingLevel() Future<int>
Get audio capture level.
groupManager() Future<RtcGroupManager?>
Get the group manager interface.
isEnabledLoudspeaker() Future<bool>
Get loudspeaker enable status.
isFrontCamera() Future<bool>
Get current camera type.
isMultiCameraCaptureSupported() Future<bool>
Indicate whether this device supports multi-camera capture. (iOS only)
joinChannel(String token, String channelId, String userId, {RtcChannelConfig? config}) Future<ResultCode>
Join the channel.
override
leaveChannel() Future<void>
Leave the channel.
override
messageService() Future<RtcMessageService?>
Get the message service interface.
muteAudio() Future<ResultCode>
Mute audio.
override
muteScreen() Future<ResultCode>
Pause screen sharing.
override
muteVideo() Future<ResultCode>
Pause video.
override
networkManager() Future<RtcNetworkManager?>
get the network manager, it can be called before initialize.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
pauseAudioMixing(int taskId) Future<ResultCode>
Pause audio mixing task.
queryDeviceRating() Future<DeviceRating>
Query the rating value of current device.
resumeAudioMixing(int taskId) Future<ResultCode>
Resume the paused audio mixing task.
seekAudioMixing(int taskId, int timestampMs) Future<ResultCode>
Seek to target timestamp.
sendAudioControlMessage(Uint8List data) Future<ResultCode>
Send audio control message in audio RTC channel.
sendFeedback(FeedbackInfo info) Future<ResultCode>
Send feedback to PANO.
setAudioDeviceVolume(int volume, AudioDeviceType type) Future<ResultCode>
Set the volume of the current audio device.
setAudioIndication(bool enable, int intervalMs) Future<ResultCode>
Set User Audio indication.
override
setEventHandler(RtcEngineEventHandler handler) → void
Sets the engine event handler.
setLoudspeakerStatus(bool enable) Future<ResultCode>
Set loudspeaker enable status.
setMicrophoneMuteStatus(bool enable) Future<ResultCode>
set microphone mute enable status
setOption(dynamic option, OptionType type) Future<ResultCode>
Set option object to PANO SDK.
setParameters(String param) Future<ResultCode>
Set customized parameters to PANO SDK.
setPlayoutDataMuteStatus(bool muted) Future<ResultCode>
Set palyout data mute status.
snapshotVideo(String outputDir, String userId, {RtcSnapshotVideoOption? option}) Future<ResultCode>
Capture specific user's video content
startAudio() Future<ResultCode>
Start audio.
override
startAudioDumpWithFilePath(String filePath, int maxFileSize) Future<ResultCode>
Start audio dump.
startAudioMixingTask(int taskId, RtcAudioMixingConfig config) Future<ResultCode>
Start audio mixing task.
startPreview(RtcSurfaceViewModel viewModel, {RtcVideoConfig? config}) Future<ResultCode>
Start current camera preview (with a render view).
startScreen({String? appGroupId}) Future<ResultCode>
Start screen capture.
override
startVideo(RtcSurfaceViewModel viewModel, {RtcVideoConfig? config}) Future<ResultCode>
Start video (with a render view).
override
stopAudio() Future<ResultCode>
Stop audio.
override
stopAudioDump() Future<ResultCode>
Stop audio dump.
stopAudioMixingTask(int taskId) Future<ResultCode>
Stop audio mixing task.
stopPreview() Future<ResultCode>
Stop current camera preview.
stopScreen() Future<ResultCode>
Stop screen capture. Returns
override
stopVideo() Future<ResultCode>
Stop video.
override
subscribeAudio(String userId) Future<ResultCode>
Subscribe to a user's audio.
override
subscribeScreen(String userId, RtcSurfaceViewModel viewModel) Future<ResultCode>
Subscribe to a user's screen sharing (with a render view).
override
subscribeVideo(String userId, RtcSurfaceViewModel viewModel, {RtcVideoConfig? config}) Future<ResultCode>
Subscribe to a user's video (with a render view).
override
switchCamera() Future<ResultCode>
Switch front and rear cameras.
switchWhiteboardEngine(String whiteboardId) Future<ResultCode>
Switch whiteboard control object.
toString() String
A string representation of this object.
inherited
unmuteAudio() Future<ResultCode>
Unmute audio.
override
unmuteScreen() Future<ResultCode>
Resume screen sharing.
override
unmuteVideo() Future<ResultCode>
Resume video.
override
unsubscribeAudio(String userId) Future<ResultCode>
Unsubscribe to a user's audio.
override
unsubscribeScreen(String userId) Future<ResultCode>
Unsubscribe to a user's screen sharing.
override
unsubscribeVideo(String userId) Future<ResultCode>
Unsubscribe to a user's video.
override
updateAudioMixingTask(int taskId, RtcAudioMixingConfig config) Future<ResultCode>
Update audio mixing task configuration.
updateConfig(RtcEngineConfig config) Future<ResultCode>
Update the configuration of the RtcEngineKit object.
override
updateScreenMoving(String userId, Point<int> distance) Future<ResultCode>
Update screen relative moving distance.
override
updateScreenScaling(String userId, ScreenScalingRatio ratio) Future<ResultCode>
Update screen absolute scaling ratio.
override
updateScreenScalingWithFocus(String userId, double ratio, Point<int> focus) Future<ResultCode>
Update screen relative scaling ratio.
override
videoStreamManager() Future<RtcVideoStreamManager?>
Get video stream manager object.
whiteboardEngine() Future<RtcWhiteboard?>
Get whiteboard control object.

Operators

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

Static Methods

engine(RtcEngineConfig config) Future<RtcEngineKit?>
Creating an RtcEngineKit object.
getSdkVersion() Future<String?>
Retrieves the PANO SDK version.