Helper class

Constructors

Helper()

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

audiooutputs → Future<List<MediaDeviceInfo>>

Return the available audiooutputs

no setter

cameras → Future<List<MediaDeviceInfo>>

Return the available cameras

no setter

screenCaptureShowCursor ↔ bool

Whether the sharer's OS mouse cursor is composited into desktop screen capture (native getDisplayMedia on Windows/Linux).

getter/setter pair

Static Methods

clearAndroidCommunicationDevice() → Future<void>

After Android app finishes a session, on audio focus loss, clear the active communication device.

ensureAudioSession() → Future<void>

Ensure audio session for iOS only

enumerateDevices(String type) → Future<List<MediaDeviceInfo>>

getMicrophoneMuteMode() → Future<MicrophoneMuteMode>

Get how the audio device module mutes microphone input.

isMicrophoneMuted() → Future<bool>

Get whether microphone input is muted at the audio device module level. Unrelated to MediaStreamTrack.enabled.

openCamera(Map<String, dynamic> mediaConstraints) → Future<MediaStream>

To select a a specific camera, you need to set constraints eg. var constraints = { 'audio': true, 'video': { 'deviceId': Helper.cameras0.deviceId, } };

requestCapturePermission({bool fullScreenOnly = false}) → Future<bool>

Request capture permission for Android/macOS.

selectAudioInput(String deviceId) → Future<void>

Set audio input device for Flutter native Note: The usual practice in flutter web is to use deviceId as the getUserMedia parameter to get a new audio track and replace it with the audio track in the original rtpsender.

selectAudioOutput(String deviceId) → Future<void>

Used to select a specific audio output device.

setAndroidAudioConfiguration(AndroidAudioConfiguration androidAudioConfiguration) → Future<void>

Set the audio configuration to for Android. Must be set before initiating a WebRTC session and cannot be changed mid session.

setAppleAudioConfiguration(AppleAudioConfiguration appleAudioConfiguration) → Future<void>

Set the audio configuration for iOS

setAppleAudioIOMode(AppleAudioIOMode mode, {bool preferSpeakerOutput = false}) → Future<void>

Set the audio configuration for iOS

setExposureMode(MediaStreamTrack videoTrack, CameraExposureMode exposureMode) → Future<void>

setExposurePoint(MediaStreamTrack videoTrack, Point<double>? point) → Future<void>

setFocusMode(MediaStreamTrack videoTrack, CameraFocusMode focusMode) → Future<void>

setFocusPoint(MediaStreamTrack videoTrack, Point<double>? point) → Future<void>

setLogger(Logger logger, [String severity = 'none']) → void

Set Logger object for webrtc;

setMicrophoneMute(bool mute, MediaStreamTrack track) → Future<void>

Set the microphone mute/unmute for Flutter native

setMicrophoneMuted(bool muted) → Future<void>

Mute or unmute microphone input at the audio device module level, honoring the mode set via setMicrophoneMuteMode on iOS/macOS. Unrelated to MediaStreamTrack.enabled.

setMicrophoneMuteMode(MicrophoneMuteMode mode) → Future<void>

Set how the audio device module mutes microphone input.

setScreenCaptureCursor(bool show) → void

Show/hide the broadcaster's mouse cursor in desktop screen capture. Applies to the NEXT screen share started via getDisplayMedia; an already running capture is unaffected.

setSpeakerphoneOn(bool enable) → Future<void>

Enable or disable speakerphone for iOS/Android only

setSpeakerphoneOnButPreferBluetooth() → Future<void>

Enable speakerphone, but use bluetooth if audio output device available for iOS/Android only

setVolume(double volume, MediaStreamTrack track) → Future<void>

Set the volume for Flutter native

setZoom(MediaStreamTrack videoTrack, double zoomLevel) → Future<void>

switchCamera(MediaStreamTrack track, [String? deviceId, MediaStream? stream]) → Future<bool>

For web implementation, make sure to pass the target deviceId