Type aliases
AudioCodecType
AudioCodecType: "OPUS"
Callbacks
Callbacks: { addstream: any; datachannel: any; disconnect: any; log: any; message: any; notify: any; push: any; removestream: any; removetrack: any; signaling: any; timeline: any; timeout: any; track: any }
Type declaration
addstream:function
- addstream(event: RTCTrackEvent): void
datachannel:function
disconnect:function
log:function
- log(title: string, message: JSONType): void
message:function
notify:function
push:function
removestream:function
- removestream(event: MediaStreamTrackEvent): void
Parameters
event: MediaStreamTrackEvent
Returns void
removetrack:function
- removetrack(event: MediaStreamTrackEvent): void
Parameters
event: MediaStreamTrackEvent
Returns void
signaling:function
timeline:function
timeout:function
track:function
- track(event: RTCTrackEvent): void
ConnectionOptions
Connection
Options
: { audio
?: boolean; audioBitRate
?: number; audioCodecType
?: AudioCodecType; audioOpusParamsChannels
?: number; audioOpusParamsClockRate
?: number; audioOpusParamsMaxplaybackrate
?: number; audioOpusParamsMinptime
?: number; audioOpusParamsPtime
?: number; audioOpusParamsSpropStereo
?: boolean; audioOpusParamsStereo
?: boolean; audioOpusParamsUsedtx
?: boolean; audioOpusParamsUseinbandfec
?: boolean; clientId
?: string; connectionTimeout
?: number; dataChannelSignaling
?: boolean; dataChannels
?: DataChannelConfiguration[]; disconnectWaitTimeout
?: number; e2ee
?: boolean; ignoreDisconnectWebSocket
?: boolean; multistream
?: boolean; signalingCandidateTimeout
?: number; signalingNotifyMetadata
?: JSONType; simulcast
?: boolean; simulcastRid
?: SimulcastRid; spotlight
?: boolean; spotlightFocusRid
?: SpotlightFocusRid; spotlightNumber
?: number; spotlightUnfocusRid
?: SpotlightFocusRid; timeout
?: number; video
?: boolean; videoBitRate
?: number; videoCodecType
?: VideoCodecType }Type declaration
Optional audio?: boolean
Optional audioBitRate?: number
Optional audioOpusParamsChannels?: number
Optional audioOpusParamsClockRate?: number
Optional audioOpusParamsMaxplaybackrate?: number
Optional audioOpusParamsMinptime?: number
Optional audioOpusParamsPtime?: number
Optional audioOpusParamsSpropStereo?: boolean
Optional audioOpusParamsStereo?: boolean
Optional audioOpusParamsUsedtx?: boolean
Optional audioOpusParamsUseinbandfec?: boolean
Optional clientId?: string
Optional connectionTimeout?: number
Optional dataChannelSignaling?: boolean
Optional disconnectWaitTimeout?: number
Optional e2ee?: boolean
Optional ignoreDisconnectWebSocket?: boolean
Optional multistream?: boolean
Optional signalingCandidateTimeout?: number
Optional signalingNotifyMetadata?: JSONType
Optional simulcast?: boolean
Optional spotlight?: boolean
Optional spotlightNumber?: number
Optional timeout?: number
Optional video?: boolean
Optional videoBitRate?: number
DataChannelConfiguration
Data
Channel
Configuration
: { compress
?: boolean; direction
: DataChannelDirection; label
: string; maxPacketLifeTime
?: number; maxRetransmits
?: number; ordered
?: boolean; protocol
?: string }Type declaration
Optional compress?: boolean
label: string
Optional maxPacketLifeTime?: number
Optional maxRetransmits?: number
Optional ordered?: boolean
Optional protocol?: string
DataChannelDirection
DataChannelDirection: "sendonly" | "sendrecv" | "recvonly"
JSONType
JSONType
: null | boolean | number | string | JSONType[] | {}Role
Role: "sendrecv" | "sendonly" | "recvonly"
SignalingNotifyConnectionCreated
Signaling
Notify
Connection
Created
: { audio
?: boolean; authn_metadata
?: JSONType; authz_metadata
?: JSONType; channel_connections
: number; channel_recvonly_connections
: number; channel_sendonly_connections
: number; channel_sendrecv_connections
: number; client_id
?: string; connection_id
?: string; data
?: SignalingNotifyMetadata[]; event_type
: "connection.created"; metadata
?: JSONType; metadata_list
?: SignalingNotifyMetadata[]; minutes
: number; role
: Role; turn_transport_type
: "udp" | "tcp"; type
: "notify"; video
?: boolean }Type declaration
Optional audio?: boolean
Optional authn_metadata?: JSONType
Optional authz_metadata?: JSONType
channel_connections: number
channel_recvonly_connections: number
channel_sendonly_connections: number
channel_sendrecv_connections: number
Optional client_id?: string
Optional connection_id?: string
event_type: "connection.created"
Optional metadata?: JSONType
minutes: number
turn_transport_type: "udp" | "tcp"
type: "notify"
Optional video?: boolean
SignalingNotifyConnectionDestroyed
Signaling
Notify
Connection
Destroyed
: { audio
?: boolean; authn_metadata
?: JSONType; authz_metadata
?: JSONType; channel_connections
: number; channel_recvonly_connections
: number; channel_sendonly_connections
: number; channel_sendrecv_connections
: number; client_id
?: string; connection_id
?: string; event_type
: "connection.destroyed"; metadata
?: JSONType; minutes
: number; role
: Role; turn_transport_type
: "udp" | "tcp"; type
: "notify"; video
?: boolean }Type declaration
Optional audio?: boolean
Optional authn_metadata?: JSONType
Optional authz_metadata?: JSONType
channel_connections: number
channel_recvonly_connections: number
channel_sendonly_connections: number
channel_sendrecv_connections: number
Optional client_id?: string
Optional connection_id?: string
event_type: "connection.destroyed"
Optional metadata?: JSONType
minutes: number
turn_transport_type: "udp" | "tcp"
type: "notify"
Optional video?: boolean
SignalingNotifyConnectionUpdated
Signaling
Notify
Connection
Updated
: { audio
?: boolean; channel_connections
: number; channel_recvonly_connections
: number; channel_sendonly_connections
: number; channel_sendrecv_connections
: number; client_id
?: string; connection_id
?: string; event_type
: "connection.updated"; minutes
: number; role
: Role; turn_transport_type
: "udp" | "tcp"; type
: "notify"; video
?: boolean }Type declaration
Optional audio?: boolean
channel_connections: number
channel_recvonly_connections: number
channel_sendonly_connections: number
channel_sendrecv_connections: number
Optional client_id?: string
Optional connection_id?: string
event_type: "connection.updated"
minutes: number
turn_transport_type: "udp" | "tcp"
type: "notify"
Optional video?: boolean
SignalingNotifyMetadata
Signaling
Notify
Metadata
: { authn_metadata
?: JSONType; authz_metadata
?: JSONType; client_id
?: string; connection_id
?: string; metadata
?: JSONType }Type declaration
Optional authn_metadata?: JSONType
Optional authz_metadata?: JSONType
Optional client_id?: string
Optional connection_id?: string
Optional metadata?: JSONType
SignalingNotifyNetworkStatus
SignalingNotifyNetworkStatus: { event_type: "network.status"; type: "notify"; unstable_level: 0 | 1 | 2 | 3 }
Type declaration
event_type: "network.status"
type: "notify"
unstable_level: 0 | 1 | 2 | 3
SignalingNotifySpotlightChanged
SignalingNotifySpotlightChanged: { audio: boolean; client_id: string | null; connection_id: string | null; event_type: "spotlight.changed"; fixed?: boolean; spotlight_id: string; type: "notify"; video: boolean }
Type declaration
audio: boolean
client_id: string | null
connection_id: string | null
event_type: "spotlight.changed"
Optional fixed?: boolean
spotlight_id: string
type: "notify"
video: boolean
SignalingNotifySpotlightFocused
SignalingNotifySpotlightFocused: { audio: boolean; client_id: string | null; connection_id: string; event_type: "spotlight.focused"; fixed: boolean; type: "notify"; video: boolean }
Type declaration
audio: boolean
client_id: string | null
connection_id: string
event_type: "spotlight.focused"
fixed: boolean
type: "notify"
video: boolean
SignalingNotifySpotlightUnfocused
SignalingNotifySpotlightUnfocused: { audio: boolean; client_id: string | null; connection_id: string; event_type: "spotlight.unfocused"; fixed: boolean; type: "notify"; video: boolean }
Type declaration
audio: boolean
client_id: string | null
connection_id: string
event_type: "spotlight.unfocused"
fixed: boolean
type: "notify"
video: boolean
SignalingPushMessage
SignalingPushMessage: { data: Record<string, unknown>; type: "push" }
Type declaration
data: Record<string, unknown>
type: "push"
SimulcastRid
SimulcastRid: "r0" | "r1" | "r2"
SoraAbendTitle
SoraAbendTitle: "CONNECTION-STATE-FAILED" | "DATA-CHANNEL-ONERROR" | "ICE-CONNECTION-STATE-DISCONNECTED-TIMEOUT" | "ICE-CONNECTION-STATE-FAILED" | "INTERNAL-ERROR" | "WEBSOCKET-ONCLOSE" | "WEBSOCKET-ONERROR"
SoraCloseEventInitDict
SoraCloseEventInitDict: { code?: number; params?: Record<string, unknown>; reason?: string }
Type declaration
Optional code?: number
Optional params?: Record<string, unknown>
Optional reason?: string
SoraCloseEventType
SoraCloseEventType: "normal" | "abend"
TimelineEventLogType
TimelineEventLogType: "websocket" | "datachannel" | "peerconnection" | "sora"
TransportType
TransportType: "websocket" | "datachannel" | "peerconnection"
VideoCodecType
VideoCodecType: "VP9" | "VP8" | "AV1" | "H264" | "H265"
SoraConnection インスタンスを生成するメソッド