Banuba WebAR JavaScript API Reference
    Preparing search index...

    Class MediaStreamCapture

    Player output to MediaStream

    Commonly used for integration with third parties (e.g WebRTC video call SDK)

    ⚠️ The functionality might not be working on iOS Safari

    Track the corresponding issue on Webkit Bug Tracker for a resolution status

    Hierarchy

    • MediaStreamSSR
      • MediaStreamCapture
    Index

    Constructors

    Properties

    active: boolean

    The active read-only property of the true if the stream is currently active; otherwise, it returns false.

    MDN Reference

    id: string

    The id read-only property of the MediaStream interface is a string containing 36 characters denoting a unique identifier (GUID) for the object.

    MDN Reference

    onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null
    onremovetrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any) | null

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Type Parameters

      • K extends keyof MediaStreamEventMap

      Parameters

      • type: K
      • listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addTrack() method of the MediaStream interface adds a new track to the stream.

      MDN Reference

      Parameters

      • track: MediaStreamTrack

      Returns void

    • The clone() method of the MediaStream interface creates a duplicate of the MediaStream.

      MDN Reference

      Returns MediaStream

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The getAudioTracks() method of the stream's track set where MediaStreamTrack.kind is audio.

      MDN Reference

      Returns MediaStreamTrack[]

    • Returns MediaStreamAudioTrack[]

    • The getTrackById() method of the MediaStream interface returns a MediaStreamTrack object representing the track with the specified ID string.

      MDN Reference

      Parameters

      • trackId: string

      Returns MediaStreamTrack | null

    • The getTracks() method of the stream's track set, regardless of MediaStreamTrack.kind.

      MDN Reference

      Returns MediaStreamTrack[]

    • The getVideoTracks() method of the js-nolint getVideoTracks() None.

      MDN Reference

      Returns MediaStreamTrack[]

    • Returns MediaStreamVideoTrack[]

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Type Parameters

      • K extends keyof MediaStreamEventMap

      Parameters

      • type: K
      • listener: (this: MediaStream, ev: MediaStreamEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeTrack() method of the MediaStream interface removes a js-nolint removeTrack(track) - track - : A MediaStreamTrack that will be removed from the stream.

      MDN Reference

      Parameters

      • track: MediaStreamTrack

      Returns void

    • Stops the capture

      Returns void