Youtube · Schema

LiveBroadcastContentDetails

Detailed settings for a live broadcast including stream configuration, DVR settings, and content configuration.

GoogleMediaSocialStreamingVideoVideos

Properties

Name	Type	Description
boundStreamId	string	The ID of the stream that is bound to the broadcast.
boundStreamLastUpdateTimeMs	string	The date and time that the live stream referenced by boundStreamId was last updated.
monitorStream	object	The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
enableEmbed	boolean	Indicates whether the broadcast video can be played in an embedded player.
enableDvr	boolean	Indicates whether the broadcast enables DVR controls. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding portions of the broadcast.
enableContentEncryption	boolean	Indicates whether YouTube should enable content encryption for the broadcast.
startWithSlate	boolean	Indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live.
closedCaptionsType	string	Indicates whether the broadcast has captions enabled.
enableLowLatency	boolean	Indicates whether this broadcast has low latency enabled.
latencyPreference	string	Indicates latency preference for the broadcast. The options are ultraLow, low, and normal.
enableAutoStart	boolean	This setting indicates whether the broadcast should automatically begin streaming.
enableAutoStop	boolean	Indicates whether the broadcast should automatically stop streaming.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LiveBroadcastContentDetails",
  "title": "LiveBroadcastContentDetails",
  "type": "object",
  "description": "Detailed settings for a live broadcast including stream configuration, DVR settings, and content configuration.",
  "properties": {
    "boundStreamId": {
      "type": "string",
      "description": "The ID of the stream that is bound to the broadcast.",
      "example": "500123"
    },
    "boundStreamLastUpdateTimeMs": {
      "type": "string",
      "description": "The date and time that the live stream referenced by boundStreamId was last updated.",
      "example": "example_value"
    },
    "monitorStream": {
      "type": "object",
      "description": "The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.",
      "properties": {
        "enableMonitorStream": {
          "type": "boolean",
          "description": "This value determines whether the monitor stream is enabled for the broadcast."
        },
        "broadcastStreamDelayMs": {
          "type": "integer",
          "description": "If you have set the enableMonitorStream property to true, this value sets the delay between the video input and the broadcast monitor stream."
        },
        "embedHtml": {
          "type": "string",
          "description": "The HTML code that embeds a player that plays the monitor stream."
        }
      },
      "example": "example_value"
    },
    "enableEmbed": {
      "type": "boolean",
      "description": "Indicates whether the broadcast video can be played in an embedded player.",
      "example": true
    },
    "enableDvr": {
      "type": "boolean",
      "description": "Indicates whether the broadcast enables DVR controls. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding portions of the broadcast.",
      "example": true
    },
    "enableContentEncryption": {
      "type": "boolean",
      "description": "Indicates whether YouTube should enable content encryption for the broadcast.",
      "example": true
    },
    "startWithSlate": {
      "type": "boolean",
      "description": "Indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live.",
      "example": true
    },
    "closedCaptionsType": {
      "type": "string",
      "description": "Indicates whether the broadcast has captions enabled.",
      "enum": [
        "closedCaptionsDisabled",
        "closedCaptionsEmbedded",
        "closedCaptionsHttpPost"
      ],
      "example": "closedCaptionsDisabled"
    },
    "enableLowLatency": {
      "type": "boolean",
      "description": "Indicates whether this broadcast has low latency enabled.",
      "example": true
    },
    "latencyPreference": {
      "type": "string",
      "description": "Indicates latency preference for the broadcast. The options are ultraLow, low, and normal.",
      "enum": [
        "low",
        "normal",
        "ultraLow"
      ],
      "example": "low"
    },
    "enableAutoStart": {
      "type": "boolean",
      "description": "This setting indicates whether the broadcast should automatically begin streaming.",
      "example": true
    },
    "enableAutoStop": {
      "type": "boolean",
      "description": "Indicates whether the broadcast should automatically stop streaming.",
      "example": true
    }
  }
}