Type alias LiveStreamMetadataDetails

LiveStreamMetadataDetails: PostMetadataCommon & {
    attachments?: AnyMedia[];
    checkLiveAPI?: URI;
    content?: Markdown;
    endsAt?: DateTime;
    liveUrl: URI;
    mainContentFocus: LIVESTREAM;
    playbackUrl: URI;
    startsAt: DateTime;
    title?: string;
}

Type declaration

  • Optional attachments?: AnyMedia[]

    The other attachments you want to include with it.

  • Optional checkLiveAPI?: URI

    The 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?: Markdown

    Optional markdown content.

  • Optional endsAt?: DateTime

    The optional stream end time (ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ).

  • liveUrl: URI

    Some livestream platforms have the live url as a separate url. If not your case make sure liveUrl and playbackUrl are the same.

  • mainContentFocus: LIVESTREAM

    The main focus of the post.

  • playbackUrl: URI

    Some livestream platforms have the playback url as a separate url. If not your case make sure liveUrl and playbackUrl are the same.

  • startsAt: DateTime

    The stream start time (ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ).

  • Optional title?: string

    The livestream title.

Settings

Member Visibility

Theme