Class RecordingServiceClient

Client to access Recording APIs

Hierarchy

RecordingServiceClient

Index

Constructors

constructor

Methods

Constructors

constructor

new RecordingServiceClient(host: string, apiKey?: string, secret?: string): RecordingServiceClient

- Defined in RecordingServiceClient.ts:20
Parameters
- host: string
  
  hostname including protocol. i.e. 'https://cluster.livekit.io'
- Optional apiKey: string
  
  API Key, can be set in env var LIVEKIT_API_KEY
- Optional secret: string
  
  API Secret, can be set in env var LIVEKIT_API_SECRET
Returns RecordingServiceClient

Methods

addOutput

addOutput(recordingId: string, rtmpUrl: string): Promise<void>

- Defined in RecordingServiceClient.ts:71
Parameters
- recordingId: string
- rtmpUrl: string
Returns Promise<void>

endRecording

endRecording(recordingId: string): Promise<void>

- Defined in RecordingServiceClient.ts:91
Parameters
- recordingId: string
Returns Promise<void>

removeOutput

removeOutput(recordingId: string, rtmpUrl: string): Promise<void>

- Defined in RecordingServiceClient.ts:81
Parameters
- recordingId: string
- rtmpUrl: string
Returns Promise<void>

startRecording

startRecording(input: string | RecordingTemplate, output: string | RtmpOutput, options?: RecordingOptions): Promise<string>

- Defined in RecordingServiceClient.ts:38
Parameters
- input: string | RecordingTemplate
  
  input url or recording template
- output: string | RtmpOutput
  
  output filepath or RtmpOutput
- Optional options: RecordingOptions
  
  recording options
Returns Promise<string>

Generated using TypeDoc