Members

constant cleanWhipSDP

Cleans up the SDP to remove any unnecessary lines.

constant DecodeWorkerOperations

Enumeration of default decode operation types that are passed to Web Worker process messaging when utilizing transforms for Insertable Streams.

constant EncodeWorkerOperations

Enumeration of default encode operation types that are passed to Web Worker process messaging when utilizing transforms for Insertable Streams.

constant FailoverPublisherEventTypes

Event types dispacthed from and specific to Red5ProPublisher.

See:

• {Red5ProPublisher}

constant FailoverSubscriberEventTypes

Event types dispatched from and specific to Red5ProSubscriber.

See:

• {Red5ProSubscriber}

constant generateSDPCandidateFrag

For WHIP/WHEP trickle ice candidates, this will generate the fragment required to send in a PATCH.

constant getRecordedLogs

Returns the stored logs if requested to record on establishment of logger.

constant IceTransportTypes

Enumeration of Support ICE Transport types.

constant injectEndOfCandidates

Injects the end-of-candidates line into the SDP.

constant injectTrickle

Injects the trickle ICE option into the SDP.

constant LiveSeekState

Enumeration of Live Seek State.

constant LiveSeekStateReadable

Human readable live seek state.

constant MessageTransportStateEventTypes

Common state event types from a message transport layer (WebSocket or RTCDataChannel).

constant pipeGeneratorWorker

Notifies defined Web Worker of read and write streams using processors and generators.

constant pipeReceiverWorker

Notifies defined Web Worker of the read and write streams for decoding specific type of media.

constant pipeSenderWorker

Notifies defined Web Worker of the read and write streams for encoding specific type of media.

constant PlaybackAudioEncoder

Enumeration of Audio Encoder types to request for Playback

constant PlaybackState

Enumeration of Playback State.

See:

• {SubscriberPlaybackControls}

constant PlaybackTypes

Enumeration of Playback Types.

constant PlaybackVideoEncoder

Enumeration of Video Encoder types to request for Playback.

constant PublishAudioEncoder

Enumeration of Audio Encoder types to request for Broadcast.

constant PublisherEventTypes

Common Publisher-based event types.

constant PublishVideoEncoder

Enumeration of Video Encoder types to request for Broadcast.

constant removeSDPLines

Removes explicit SDP lines from the SDP.

constant removeTrickle

Removes the trickle ICE option from the SDP.

constant RTCPublisherEventTypes

Event types dispatched from and specific to RTCPublisher.

See:

• {RTCPublisher}

constant RTCSubscriberEventTypes

Event types dispatched from and specific to RTCSubscriber.

See:

• {RTCSubscriber}

constant RTMPPublisherEventTypes

Event types dispatched from and specific to RTMPPublisher.

See:

• {RTMPPublisher}

constant RTMPSubscriberEventTypes

Event type dispatched from and specific to RTMPSubscriber.

See:

• {RTMPSubscriber}

constant setWorkerOnReceiver

Defines the RTCRtpScriptTransform for an audio or video receiver.

constant SharedObjectEventTypes

Common event types on SharedObject.

See:

• {Red5ProSharedObject}

constant SubscriberEventTypes

Common event types on all Subscribers.

constant TransformFrameTypes

Enumeration of Transform Frame types used during utilization of Insertable Streams.

BUFFER: Will pass an ArrayBuffer of data to the transform function specified. PACKET: Will pass either a VideoFrame or AudioData to the transform function specified.

Methods

addResponseHandler(handler)

Adds a response handler to be invoked with respond() to message and return a boolean of whether the handler handled the message.

Parameters:

Name	Type	Description
handler	Object	Handler object that has the message respond(message) on its API.

addSharedObjectResponseHandler(handler)

Adds a SharedObject response handler. Handlers are requested to respond to a message in handleMessageResponse.

Parameters:

Name	Type	Description
handler	Object

closeSharedObject(name)

Request to close the SharedObject connection over WebSocket.

Parameters:

Name	Type	Description
name	String

connectToSharedObject(name)

Request to connect to SharedObject from server over WebSocket.

Parameters:

Name	Type	Description
name	String

getJsonFromSocketMessage(message)

Request to parse JSON from message received over WebSocket.

Parameters:

Name	Type	Description
message	Object	String or Object.

getRemoteSharedObject(name)

Request to get SharedObject from server over WebSocket.

Parameters:

Name	Type	Description
name	String

handleMessageResponse(message) → {Boolean}

Traverses list of response handlers and returns flag of it being handled within the chain.

Parameters:

Name	Type	Description
message	Object

Returns:

Boolean

post(Request)

Posts request over message layer.

Parameters:

Name	Type	Description
Request	Object	object to be turned into JSON string for transport.

postAsync(sendRequest)

Request to post data over message layer and receive a call back asynchronously from the server.

Parameters:

Name	Type	Description
sendRequest	Object

removeSharedObjectResponseHandler(handler)

Removes a SharedObject response handler.

Parameters:

Name	Type	Description
handler	Object

respond(message)

Responds to messages coming over the WebSocket connection.

Parameters:

Name	Type	Description
message	Object

sendPropertyToSharedObject(name, key, value)

Request to update property on SharedObject over WebSocket.

Parameters:

Name	Type	Description
name	String
key	String
value	String

sendToSharedObject(name, methodName, data)

Request to send method call to SharedObject over WebSocket.

Parameters:

Name	Type	Description
name	String
methodName	String
data	Object