medea_flutter_webrtc library
Classes
- AudioConstraints
- DeviceMediaConstraints for audio devices.
- AudioRenderer
- Renderer for audio MediaStreamTracks.
-
DeviceConstraintMap<
T extends DeviceMediaConstraints> - Abstract device constraint property.
- DeviceConstraints
- Device audio and video constraints data.
- DeviceMediaConstraints
- Some device abstract constraints.
- DeviceVideoConstraints
- Device constraints related to a video.
- DisplayConstraints
- Device audio and video constraints data.
- IceCandidate
- Candidate Interactive Connectivity Establishment (ICE) configuration which may be used to establish a peer connection.
- IceCandidateErrorEvent
- Description of the error occurred with ICE candidate from a peer connection.
- IceServer
- ICE server which should be used by some peer connection.
- MediaDeviceInfo
- Information about some media device.
- MediaDisplayInfo
- Information about a display.
- MediaStreamTrack
- Abstract representation of a single media unit on native or web side.
- NativeVideoRenderer
- VideoRenderer implementation for the native platform.
- PeerConnection
- RTCPeerConnection representation.
- RtcAudioSourceStats
- RtcStats fields of audio RtcMediaSourceStats.
- RtcIceCandidatePairStats
- ICE candidate pair statistics related to the RTCIceTransport objects.
- RtcIceCandidateStats
-
Properties of a
candidate
in Section 15.1 of RFC 5245. It corresponds to a RTCIceTransport object. - RtcInboundRtpStreamAudio
- Audio RtcInboundRtpStreamMediaType.
- RtcInboundRtpStreamMediaType
- Media type pf RtcInboundRtpStreamStats.
- RtcInboundRtpStreamStats
- Statistics for an inbound RTP stream that is currently received with RTCPeerConnection object.
- RtcInboundRtpStreamVideo
- Video RtcInboundRtpStreamMediaType.
- RtcLocalIceCandidateStats
- Local RtcIceCandidateStats.
- RtcMediaSourceStats
- Statistics for the media produced by a MediaStreamTrack that is currently attached to an RTCRtpSender. This reflects the media that is fed to the encoder after getUserMedia() constraints have been applied (i.e. not the raw media produced by the camera).
- RtcOutboundRtpStreamStats
- Statistics for an outbound RTP stream that is currently sent with RTCPeerConnection object.
- RtcOutboundRtpStreamStatsAudio
- Audio RtcOutboundRtpStreamStatsMediaType.
- RtcOutboundRtpStreamStatsMediaType
- RtcOutboundRtpStreamStatsVideo
- Video RtcOutboundRtpStreamStatsMediaType.
- RtcRemoteIceCandidateStats
- Remote RtcIceCandidateStats.
- RtcRemoteInboundRtpStreamStats
- Statistics for the remote endpoint's inbound RTP stream corresponding to an outbound stream that is currently sent with RTCPeerConnection object.
- RtcRemoteOutboundRtpStreamStats
- Statistics for the remote endpoint's outbound RTP stream corresponding to an inbound stream that is currently received with RTCPeerConnection object.
- RtcStats
- Represents the stats object constructed by inspecting a specific monitored object.
- RtcStatsType
- All known types of RtcStats.
- RtcTransportStats
- Transport statistics related to the RTCPeerConnection object.
- RtcVideoSourceStats
- RtcStats fields of video RtcMediaSourceStats.
- RTCVideoValue
- RtpParameters
- RTCRtpParameters implementation.
- RtpSender
- RTCSender implementation.
- RtpTransceiver
- RTCTransceiver representation
- RtpTransceiverInit
-
Init config for an
RtpTransceiver
creation. - SendEncodingParameters
- Encoding describing a single configuration of a codec for an RTCRtpSender.
- SessionDescription
- SDP offer which can be set to a peer connection.
- VideoRenderer
- VideoView
Enums
- CandidateType
- RTCIceCandidateType represents the type of the ICE candidate, as defined in Section 15.1 of RFC 5245.
- FacingMode
- Possible directions in which a camera may produce video.
- GetMediaExceptionKind
-
Represents the
cause
of the GetMediaException. - IceConnectionState
- Current state of an ICE agent and its connection.
- IceGatheringState
- Connection's ICE gathering state.
- IceRole
- Variants of ICE roles.
- IceTransportType
- ICE transport which should be used by some peer connection.
- MediaDeviceKind
- Media device kind.
- MediaKind
- Kind of a media.
- MediaStreamTrackState
-
Representation of a
MediaStreamTrack
readiness. - PeerConnectionState
- Current state of a peer connection.
- Protocol
- Transport protocols used in WebRTC.
- RtcStatsIceCandidatePairState
- Each candidate pair in the check list has a foundation and a state. The foundation is the combination of the foundations of the local and remote candidates in the pair. The state is assigned once the check list for each media stream has been computed. There are five potential values that the state can have.
- SessionDescriptionType
- Type of a SessionDescription.
- SignalingState
- State of a signaling process on a local end of a connection while connecting or reconnecting to another peer.
- TransceiverDirection
-
Direction of an
RtpTransceiver
. - VideoViewObjectFit
Constants
- defaultDisplayMediaHeight → const int
- Default video height when capturing user's display.
- defaultDisplayMediaWidth → const int
- Default video width when capturing user's display.
- defaultFrameRate → const int
- Default video framerate.
- defaultUserMediaHeight → const int
- Default video height when capturing user's camera.
- defaultUserMediaWidth → const int
- Default video width when capturing user's camera.
Properties
Functions
-
buildBridge(
) → MedeaFlutterWebrtcNative? -
Opens the dynamic library and instantiates
ffi.MedeaFlutterWebrtcNative
. -
createAudioRenderer(
) → AudioRenderer - Creates a new platform-specific AudioRenderer.
-
createPlatformSpecificVideoRenderer(
) → VideoRenderer - Creates a new NativeVideoRenderer.
-
createVideoRenderer(
) → VideoRenderer -
enableFakeMedia(
) → Future< void> - Configures media acquisition to use fake devices instead of actual camera and microphone.
-
enumerateDevices(
) → Future< List< MediaDeviceInfo> > - Returns list of MediaDeviceInfos for the currently available devices.
-
enumerateDisplays(
) → Future< List< MediaDisplayInfo> > - Returns list of MediaDisplayInfos for the currently available displays.
-
getDisplayMedia(
DisplayConstraints constraints) → Future< List< NativeMediaStreamTrack> > -
Returns list of local display
NativeMediaStreamTrack
s based on the provided DisplayConstraints. -
getUserMedia(
DeviceConstraints constraints) → Future< List< NativeMediaStreamTrack> > -
Returns list of local audio and video
NativeMediaStreamTrack
s based on the provided DeviceConstraints. -
iceCandidatePairStateTryFromString(
String state) → RtcStatsIceCandidatePairState? - Tries to parse a String as an RtcStatsIceCandidatePairState.
-
microphoneVolume(
) → Future< int> - Returns the current level of the microphone volume in percents.
-
microphoneVolumeIsAvailable(
) → Future< bool> - Indicates whether the microphone is available to set volume.
-
onDeviceChange(
OnDeviceChangeCallback? cb) → void -
Sets the provided
`OnDeviceChangeCallback`
as the callback to be called whenever a set of available media devices changes. -
setMicrophoneVolume(
int level) → Future< void> -
Sets the microphone system volume according to the specified
level
in percents. -
setOutputAudioId(
String deviceId) → Future< void> -
Switches the current output audio device to the provided
deviceId
. -
tryParse(
dynamic value) → int? -
Tries to parse the provided
value
as int.
Typedefs
- OnConnectionStateChangeCallback = void Function(PeerConnectionState)
-
Shortcut for the
on_connection_state_change
callback. - OnDeviceChangeCallback = void Function()
-
Shortcut for the
on_device_change
callback. - OnEndedCallback = void Function()
-
Representation of the
onEnded
callback. - OnIceCandidateCallback = void Function(IceCandidate)
-
Shortcut for the
on_ice_candidate
callback. - OnIceCandidateErrorCallback = void Function(IceCandidateErrorEvent)
-
Shortcut for the
on_ice_candidate_error
callback. - OnIceConnectionStateChangeCallback = void Function(IceConnectionState)
-
Shortcut for the
on_ice_connection_state_change
callback. - OnIceGatheringStateChangeCallback = void Function(IceGatheringState)
-
Shortcut for the
on_ice_gathering_state_change
callback. - OnNegotiationNeededCallback = void Function()
-
Shortcut for the
on_negotiation_needed
callback. - OnSignalingStateChangeCallback = void Function(SignalingState)
-
Shortcut for the
on_signaling_state_change
callback. - OnTrackCallback = void Function(NativeMediaStreamTrack, RtpTransceiver)
-
Shortcut for the
on_track
callback.
Exceptions / Errors
- GetMediaException
-
Exception thrown if there is an
error
while calling getUserMedia or getDisplayMedia.