Whether the event has a default behaviour that may be prevented by calling Event.preventDefault
The recording ID generated in openvidu-server
The recording name you supplied to openvidu-server. For example, to name your recording file MY_RECORDING:
/api/recordings/start passing JSON body {"session":"sessionId","name":"MY_RECORDING"}OpenVidu.startRecording(sessionId, MY_RECORDING) or OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name(MY_RECORDING).build())OpenVidu.startRecording(sessionId, MY_RECORDING) or OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name(MY_RECORDING).build())If no name is supplied, this property will be undefined and the recorded file will be named after property id
The object that dispatched the event
The type of event. This is the same string you pass as first parameter when calling method on() of any object implementing EventDispatcher interface
Whether the default beahivour of the event has been prevented or not. Call Event.preventDefault to prevent it
Prevents the default behaviour of the event. The following events have a default behaviour:
sessionDisconnected: automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
and also deletes the HTML video element associated to it.streamDestroyed: if dispatched by a Publisher (you have unpublished), automatically stops all media tracks and deletes the HTML video element associated to the stream. If dispatched by Session,
(other user has unpublished), automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and deletes the HTML video element associated to it.Generated using TypeDoc
Defines the following events:
recordingStarted: dispatched by SessionrecordingStopped: dispatched by Session