core/index library
Classes
- AcceptLobbyPeer
- ActivateSpeakerNotification
- AndroidAudioConfiguration
- AndroidNativeAudioManagement
- AppData
- AppleAudioConfiguration
- AppleNativeAudioManagement
- AudioOutputOptions
- An object that configures what device(s) may be offered in the user prompt.
- CanProduceByKind
- CloseConsumer
- CloseConsumerSuccess
- CloseProducer
- CloseProducerSuccess
- CloseRoom
- CloseStreamOfLabel
- CodecParameters
- ConnectRoom
- ConnectRoomResponse
- ConnectRoomResponse_RTCIceServer
- ConnectTransport
- ConnectTransportResponse
- Consume
- ConsumeArguments
- ConsumeDataResponse
- Consumer
- ConsumeResponse
- ConsumerOptions
- CreateDataConsumer
- CreateTransport
- CreateTransportOnClient
-
CustomValueNotifier<
T> - DataConsumer
- DataConsumerOptions
- DataProducer
- DataProducerOptions
- DenyLobbyPeer
- DesktopCapturer
- DesktopCapturerSource
- Device
- DeviceHandler
- Handle the stream related operations for the Huddle01 SDK
- DtlsFingerprint
- DtlsParameters
- EnhancedEventEmitter
-
EnhancedMap<
T> - Error
- ExtendedRtpCodec
- ExtendedRtpHeaderExtension
- FrameCryptor
- Frame encryption/decryption.
- FrameCryptorFactory
- Factory for creating frame Cryptors. For End 2 End Encryption, you need to create a KeyProvider for each peer. And set your key in keyProvider.
- GeolocationSchema
- Hello
- Helper
- IceCandidate
- IceParameters
- KeyProvider
- Shared secret key for frame encryption.
- KeyProviderOptions
- KickPeer
- LobbyPeerLeft
- LobbyPeers
- LocalPeer
- LocalPeer is the main class which handles all the functionality of the client Where Client Means the currently Running Application.
- Log
- MediaDeviceInfo
- This describe the media input and output devices, such as microphones, cameras, headsets, and so forth.
- MediaDevices
- MediaRecorder
- MediaStream
- https://w3c.github.io/mediacapture-main/#mediastream
- MediaStreamConstraints
- MediaStreamTrack
- MediaTrackSupportedConstraints
- MediaTrackSupportedConstraints represents the list of constraints controlling the capabilities of a MediaStreamTrack.
- NewLobbyPeer
- NewPeerJoined
- NewPeerRole
- NewPermissions
- NewRoomControls
- NumSctpStreams
- PeerLeft
- PeerMetadataUpdated
- PeersInfo
- PeersInfo_ProducerInfo
- Permissions
-
Permission Class of a Local Peer in a Room.
NOTE Permissions are enforced by the Server. and can be set using the token or can be updated by Remote Peers having admin access of the Room Joined - PlainRtpParameters
- Produce
- ProduceArguments
- ProduceData
- ProduceDataResponse
- Producer
- ProducerCodecOptions
- ProduceResponse
- ProducerOptions
- ProtoDtlsFingerPrints
- ProtoDtlsParameters
- ProtoIceCandidates
- ProtoIceParameters
- ProtoSctpParameters
- ProtoTransportSDPInfo
- ReceiveData
- RemotePeer
- Request
- Response
- RestartTransportIce
- RestartTransportIceResponse
- ResumeConsumer
- Room
- RoomClosedProducers
- RoomClosedProducers_CloseProducerInfo
- RoomClosedProducers_CloseProducerReason
- RoomControls
- RoomControls_ProduceSources
- RoomInfo
- RoomMetadataUpdated
- RTCDataChannel
- RTCDataChannelInit
- RTCDataChannelMessage
- A class that represents a datachannel message. Can either contain binary data as a Uint8List or text data as a String.
- RTCDTMFSender
- RTCFactory
- RTCFactoryNative
- RTCHeaderExtension
- RTCIceCandidate
- RTCPeerConnection
- RtcpFeedback
- RtcpParameters
- Provides information on RTCP settings within the RTP parameters.
- RTCRTCPParameters
- RTCRtpCapabilities
- RTCRTPCodec
- RTCRtpCodecCapability
- RTCRtpEncoding
- RTCRtpHeaderExtensionCapability
- RTCRtpParameters
- RTCRtpReceiver
- RTCRtpSender
- RTCRtpTransceiver
- RTCRtpTransceiverInit
- RTCSessionDescription
- RTCTrackEvent
- RTCVideoRenderer
- RTCVideoValue
- RTCVideoView
- RtpCapabilities
- The RTP capabilities define what mediasoup or an endpoint can receive at media level.
- RtpCodecCapability
- RtpCodecParameters
- Provides information on codec settings within the RTP parameters. The list of media codecs supported by mediasoup and their settings is defined in the supportedRtpCapabilities.ts file.
- RtpEncodingParameters
- RtpHeaderExtension
- RtpHeaderExtensionParameters
- Defines a RTP header extension within the RTP parameters. The list of RTP header extensions supported by mediasoup is defined in the supportedRtpCapabilities.ts file.
- RtpParameters
- The RTP send parameters describe a media stream received by mediasoup from an endpoint through its corresponding mediasoup Producer. These parameters may include a mid value that the mediasoup transport will use to match received RTP packets based on their MID RTP extension value.
- RtxSsrc
- ScalabilityMode
- SctpCapabilities
- SctpParameters
- SctpStreamParameters
- SendData
- SendDataChannelArguments
- Socket
- Handles the underlying socket connection with the socket server
- StatsReport
- SyncMeetingState
- SyncMeetingStateResponse
- TestEvent
- ThumbnailSize
- Transport
- UpdatePeerMetadata
- UpdatePeerPermission
- UpdatePeerRole
- UpdateRoomControls
- UpdateRoomMetadata
- Value
- VideoRenderer
- WaitingRoom
- WebRTC
Enums
- AdapterType
- Algorithm
- Built-in Algorithm.
- AndroidAudioAttributesContentType
- AndroidAudioAttributesUsageType
- AndroidAudioFocusMode
- AndroidAudioMode
- AndroidAudioStreamType
- AppleAudioCategory
- AppleAudioCategoryOption
- AppleAudioIOMode
- AppleAudioMode
- AudioTrackConfig
- ConnectionState
- CustomMediaDevice
- Direction
- DtlsRole
- ESocketCloseCode
- FrameCryptorState
- IceCandidateType
- MediaDeviceType
- MessageType
- RTCDataChannelMessage type
- PermissionType
- Priority
- ProduceSources
- Protocol
- RecorderAudioChannel
- Request_Request
- Response_Response
- RoomStates
- RTCDataChannelState
- RTCDegradationPreference
- RTCIceConnectionState
- RTCIceGatheringState
- RTCPeerConnectionState
- RTCRtpMediaType
- RTCSignalingState
- RTCVideoViewObjectFit
- RtpHeaderDirection
- Direction of RTP header extension.
- SourceType
- TcpType
- TransceiverDirection
- TransportType
- UpdateRoomControls_Control
- Value_ValueType
- VideoTrackConfig
Extensions
- AdapterTypeExt on AdapterType
- AndroidAudioAttributesContentTypeEnumEx on String
- AndroidAudioAttributesContentTypeExt on AndroidAudioAttributesContentType
- AndroidAudioAttributesUsageTypeEnumEx on String
- AndroidAudioAttributesUsageTypeExt on AndroidAudioAttributesUsageType
- AndroidAudioFocusModeEnumEx on String
- AndroidAudioFocusModeExt on AndroidAudioFocusMode
- AndroidAudioModeEnumEx on String
- AndroidAudioModeExt on AndroidAudioMode
- AndroidAudioStreamTypeEnumEx on String
- AndroidAudioStreamTypeExt on AndroidAudioStreamType
- AppleAudioCategoryEnumEx on String
- AppleAudioCategoryExt on AppleAudioCategory
- AppleAudioCategoryOptionEnumEx on String
- AppleAudioCategoryOptionExt on AppleAudioCategoryOption
- AppleAudioModeEnumEx on String
- AppleAudioModeExt on AppleAudioMode
- CustomMediaDeviceExtension on CustomMediaDevice
- DirectionExtension on Direction
- DtlsRoleExtension on DtlsRole
- ESocketCloseCodeExtension on ESocketCloseCode
- IceCandidateTypeExtension on IceCandidateType
- MediaDeviceTypeExtension on MediaDeviceType
- PriorityExtension on Priority
- ProtocolExtension on Protocol
- RTCRtpMediaTypeExtension on RTCRtpMediaType
- RtpHeaderDirectionExtension on RtpHeaderDirection
- TcpTypeExtension on TcpType
- TransportTypeExtension on TransportType
Constants
- maxDataMessageSize → const int
Properties
-
audioTrackConfigMap
↔ Map<
AudioTrackConfig, Map< String, dynamic> > -
getter/setter pair
- desktopCapturer → DesktopCapturer
-
no setter
-
desktopSourceTypeToString
→ Map<
SourceType, String> -
final
- frameCryptorFactory → FrameCryptorFactory
-
no setter
- logger → Logger
-
no setter
- mediaDevices → MediaDevices
-
no setter
-
no setter
-
peersNotifier
↔ CustomValueNotifier<
Map< String, dynamic> > -
getter/setter pair
-
permissionsValueNotifier
↔ CustomValueNotifier<
Map< String, dynamic> > -
getter/setter pair
- scalabilityModeRegex ↔ RegExp
-
getter/setter pair
-
socketCloseReason
↔ Map<
ESocketCloseCode, String> -
getter/setter pair
-
tringToDesktopSourceType
→ Map<
String, SourceType> -
final
-
typeRTCDegradationPreferenceString
→ Map<
RTCDegradationPreference, String> -
final
-
typeRTCRtpMediaTypetoString
→ Map<
RTCRtpMediaType, String> -
final
-
typeRtpTransceiverDirectionToString
→ Map<
TransceiverDirection, String> -
final
-
typeStringToRTCRtpMediaType
→ Map<
String, RTCRtpMediaType> -
final
-
typeStringToRtpTransceiverDirection
→ Map<
String, TransceiverDirection> -
final
-
videotrackConfigMap
↔ Map<
VideoTrackConfig, Map< String, dynamic> > -
getter/setter pair
Functions
-
checkPermission(
{PermissionType? permissionTypeCheck, ProduceSources? produceSourcesCheck}) → bool -
convertMap(
Map dynamicMap) → Map< String, String> ? -
convertToProtobufMap(
Map? originalMap) → Map< String, Value> ? -
createLocalMediaStream(
String label) → Future< MediaStream> -
createPeerConnection(
Map< String, dynamic> configuration, [Map<String, dynamic> constraints = const {}]) → Future<RTCPeerConnection> -
defaultCompareFn(
String a, String b) → bool -
degradationPreferenceforString(
String? degradation) → RTCDegradationPreference -
getParsedProtoDtlsParameters(
{required DtlsParameters parameters}) → ProtoDtlsParameters -
getProtoRtpParameters(
{required RtpParameters rtpParameters}) → ProtoRtpParameters -
getProtoSctpCapabilities(
{required Device? device}) → ProtoSctpCapabilities -
getRtpReceiverCapabilities(
String kind) → Future< RTCRtpCapabilities> -
getRtpSenderCapabilities(
String kind) → Future< RTCRtpCapabilities> -
iceConnectionStateForString(
String? state) → RTCIceConnectionState -
iceGatheringStateforString(
String? state) → RTCIceGatheringState -
listToRtpEncodings(
List< Map< list) → List<String, dynamic> >RTCRtpEncoding> -
mediaRecorder(
) → MediaRecorder -
peerConnectionStateForString(
String? state) → RTCPeerConnectionState -
rtcDataChannelStateForString(
String state) → RTCDataChannelState -
signalingStateForString(
String? state) → RTCSignalingState
Typedefs
- ConsumerOnTrackEnded = void Function()
- StreamTrackCallback = dynamic Function()