Interface: RecordingsApi

The methods of Talkline.recordings.

Methods

get()

get(sid): Promise<Recording>;

GET /v1/recordings/{sid}.

Parameters

Parameter	Type
sid	string

Returns

Promise<Recording>

---

iterate()

iterate(query?): AsyncIterable<Recording>;

GET /v1/recordings, every page in turn.

Parameters

Parameter	Type
query?	Pageless<ListRecordingsQuery>

Returns

AsyncIterable<Recording>

---

list()

list(query?): Promise<Page<Recording>>;

GET /v1/recordings, one page.

Parameters

Parameter	Type
query?	ListRecordingsQuery

Returns

Promise<Page<Recording>>

---

start()

start(roomSid): Promise<Recording>;

POST /v1/rooms/{sid}/recordings: records a room now — an sfu room, created with a recordingPolicy other than off, that someone has joined. Its participants are told first.

Parameters

Parameter	Type
roomSid	string

Returns

Promise<Recording>

---

stop()

stop(sid): Promise<Recording>;

POST /v1/recordings/{sid}/stop: answered once its files are final; recording.finished follows their upload.

Parameters

Parameter	Type
sid	string

Returns

Promise<Recording>

---

urls()

urls(sid, query?): Promise<RecordingUrls>;

GET /v1/recordings/{sid}/url: signed URLs to fetch a finished recording's files and timeline from the object store.

Parameters

Parameter	Type
sid	string
query?	RecordingUrlsQuery

Returns

Promise<RecordingUrls>