Optional
attachments?: AnyMedia[]Optional
checkThe data cannot be changed so you can put in an API endpoint to know if it is still live or not for clients to be able to check.
Responses from this endpoint should conform to the following schema:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"isLive": {
"type": "boolean"
}
},
"required": ["isLive"]
}
Optional
content?: EncryptableMarkdownOptional markdown content.
Optional
endsThe optional stream end time (ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ
).
Some livestream platforms have the live url as a separate url.
If not your case make sure liveUrl
and playbackUrl
are the same.
The main focus of the post.
Some livestream platforms have the playback url as a separate url.
If not your case make sure liveUrl
and playbackUrl
are the same.
The stream start time (ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ
).
Optional
title?: stringThe livestream title.
The other attachments you want to include with it.