kotlin-browser/web.rtc/RTCRtpScriptTransformer

RTCRtpScriptTransformer

open class RTCRtpScriptTransformer : EventTarget(source)

The RTCRtpScriptTransformer interface of the WebRTC API provides a worker-side Stream API interface that a WebRTC Encoded Transform can use to modify encoded media frames in the incoming and outgoing WebRTC pipelines.

MDN Reference

Properties

Link copied to clipboard
val options: JsAny?

The options read-only property of the RTCRtpScriptTransformer interface returns the object that was (optionally) passed as the second argument during construction of the corresponding RTCRtpScriptTransform.

Link copied to clipboard
val readable: ReadableStream<*>

The readable read-only property of the RTCRtpScriptTransformer interface returns a ReadableStream instance is a source for encoded media frames.

Link copied to clipboard
val writable: WritableStream<*>

The writable read-only property of the RTCRtpScriptTransformer interface returns a WritableStream instance that can be used as a sink for encoded media frames enqueued on the corresponding RTCRtpScriptTransformer.readable.

Functions

Link copied to clipboard
open fun dispatchEvent(event: Event): Boolean
Link copied to clipboard
inline suspend fun RTCRtpScriptTransformer.generateKeyFrame()
inline suspend fun RTCRtpScriptTransformer.generateKeyFrame(rid: String)

The generateKeyFrame() method of the RTCRtpScriptTransformer interface causes a video encoder to generate a key frame.

Link copied to clipboard
fun generateKeyFrameAsync(rid: String = definedExternally): Promise<Void?>

The generateKeyFrame() method of the RTCRtpScriptTransformer interface causes a video encoder to generate a key frame.

Link copied to clipboard
inline suspend fun RTCRtpScriptTransformer.sendKeyFrameRequest()

The sendKeyFrameRequest() method of the RTCRtpScriptTransformer interface may be called by a WebRTC Encoded Transform that is processing incoming encoded video frames, in order to request a key frame from the sender.

Link copied to clipboard
fun sendKeyFrameRequestAsync(): Promise<Void?>

The sendKeyFrameRequest() method of the RTCRtpScriptTransformer interface may be called by a WebRTC Encoded Transform that is processing incoming encoded video frames, in order to request a key frame from the sender.

Link copied to clipboard
fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>