OpenVidu Browser - v2.32.2
    Preparing search index...

    Class RecordingEvent

    Triggered by:

    Hierarchy (View Summary)

    Index

    Properties

    cancelable id name? reason? target type

    Methods

    isDefaultPrevented preventDefault

    Properties

    cancelable: boolean

    Whether the event has a default behavior that may be prevented by calling Event.preventDefault

    id: string

    The recording ID generated in openvidu-server

    name?: string

    The recording name you supplied to openvidu-server. For example, to name your recording file MY_RECORDING:

    • With API REST: POST to /api/recordings/start passing JSON body {"session":"sessionId","name":"MY_RECORDING"}
    • With openvidu-java-client: OpenVidu.startRecording(sessionId, "MY_RECORDING") or OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name("MY_RECORDING").build())
    • With openvidu-node-client: OpenVidu.startRecording(sessionId, "MY_RECORDING") or OpenVidu.startRecording(sessionId, {name: "MY_RECORDING"})

    If no name is supplied, this property will be undefined and the recorded file will be named after property id

    reason?: RecordingEventReason

    For 'recordingStopped' event:

    • "recordingStoppedByServer": the recording has been gracefully stopped by the application
    • "sessionClosedByServer": the Session has been closed by the application
    • "automaticStop": see Automatic stop of recordings
    • "nodeCrashed": a node has crashed in the server side

    For 'recordingStarted' empty string

    target: Session | StreamManager | Filter

    The object that dispatched the event

    type: string

    The type of event. This is the same string you pass as first parameter when calling method on() of any object implementing EventDispatcher interface

    Methods

    • Prevents the default behavior of the event. The following events have a default behavior:

      • sessionDisconnected: dispatched by Session object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the RTCPeerConnection and disposing all MediaStreamTracks) and also deletes any HTML video element associated to each Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method Session.subscribe or by calling Subscriber.createVideoElement). For every video removed, each Subscriber object will also dispatch a videoElementDestroyed event.

      • streamDestroyed:

        • If dispatched by a Publisher (you have unpublished): automatically stops all media tracks and deletes any HTML video element associated to it (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method OpenVidu.initPublisher or by calling Publisher.createVideoElement). For every video removed, the Publisher object will also dispatch a videoElementDestroyed event.
        • If dispatched by Session (other user has unpublished): automatically unsubscribes the proper Subscriber object from the session (this includes closing the RTCPeerConnection and disposing all MediaStreamTracks) and also deletes any HTML video element associated to that Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method Session.subscribe or by calling Subscriber.createVideoElement). For every video removed, the Subscriber object will also dispatch a videoElementDestroyed event.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods