Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OpenVidu

Hierarchy

  • OpenVidu

Index

Constructors

Methods

Constructors

constructor

  • new OpenVidu(urlOpenViduServer: string, secret: string): OpenVidu

  • Parameters

    • urlOpenViduServer: string

      Public accessible IP where your instance of OpenVidu Server is up an running

    • secret: string

      Secret used on OpenVidu Server initialization

    Returns OpenVidu

Methods

createSession

deleteRecording

  • deleteRecording(recordingId: string): Promise<Error>

  • Deletes a Recording. The recording must have status stopped or available

    Parameters

    • recordingId: string

    Returns Promise<Error>

    A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no recording exists for the passed recordingId
    • 409: the recording has started status. Stop it before deletion

getRecording

  • getRecording(recordingId: string): Promise<Recording>

  • Gets an existing Recording

    Parameters

    • recordingId: string

      The id property of the Recording you want to retrieve

    Returns Promise<Recording>

    A Promise that is resolved to the Recording if it successfully stopped and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no recording exists for the passed recordingId

listRecordings

  • Lists all existing recordings

    Returns Promise<Recording[]>

    A Promise that is resolved to an array with all existing recordings

startRecording

  • Starts the recording of a Session

    Parameters

    • sessionId: string

      The sessionId of the Session you want to start recording

    Returns Promise<Recording>

    A Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no session exists for the passed sessionId
    • 400: the session has no connected participants
    • 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded

  • Starts the recording of a Session

    Parameters

    • sessionId: string

      The sessionId of the Session you want to start recording

    • name: string

      The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)

    Returns Promise<Recording>

    A Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no session exists for the passed sessionId
    • 400: the session has no connected participants
    • 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded

  • Starts the recording of a Session

    Parameters

    Returns Promise<Recording>

    A Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no session exists for the passed sessionId
    • 400: the session has no connected participants
    • 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded

stopRecording

  • stopRecording(recordingId: string): Promise<Recording>

  • Stops the recording of a Session

    Parameters

    • recordingId: string

      The id property of the Recording you want to stop

    Returns Promise<Recording>

    A Promise that is resolved to the Recording if it successfully stopped and rejected with an Error object if not. This Error object has as message property with the following values:

    • 404: no recording exists for the passed recordingId
    • 406: recording has starting status. Wait until started status before stopping the recording

Generated using TypeDoc