Youtube · JSON Structure
Youtube Live Live Stream Structure
A liveStream resource contains information about the video stream that you are transmitting to YouTube. The stream provides the content that will be broadcast to YouTube users.
Type: object
Properties: 7
Required: 2
GoogleMediaSocialStreamingVideoVideos
LiveStream is a JSON Structure definition published by Youtube, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.
Properties
kind
etag
id
snippet
cdn
status
contentDetails
Meta-schema: https://json-structure.org/draft/2020-12/schema
JSON Structure
{
"type": "object",
"description": "A liveStream resource contains information about the video stream that you are transmitting to YouTube. The stream provides the content that will be broadcast to YouTube users.",
"name": "LiveStream",
"properties": {
"kind": {
"type": "string",
"description": "Identifies the API resource's type. Value is youtube#liveStream."
},
"etag": {
"type": "string",
"description": "The Etag of this resource."
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the stream."
},
"snippet": {
"type": "object",
"description": "Basic details about a live stream including its title, description, and channel association.",
"properties": {
"channelId": {
"type": "string",
"description": "The ID of the channel to which this stream is affiliated."
},
"title": {
"type": "string",
"description": "The stream's title. The value must be between 1 and 128 characters long."
},
"description": {
"type": "string",
"description": "The stream's description. The value cannot be longer than 10000 characters."
},
"publishedAt": {
"type": "datetime",
"description": "The date and time that the stream was created."
},
"isDefaultStream": {
"type": "boolean",
"description": "Indicates whether this stream is the default stream."
}
}
},
"cdn": {
"type": "object",
"description": "The cdn object defines the live stream's content delivery network (CDN) settings.",
"properties": {
"ingestionType": {
"type": "string",
"description": "The method or protocol used to transmit the video stream.",
"enum": [
"dash",
"rtmp",
"webrtc"
]
},
"ingestionInfo": {
"type": "object",
"description": "The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.",
"properties": {
"streamName": {
"type": "string",
"description": "The stream name that YouTube assigns to the video stream."
},
"ingestionAddress": {
"type": "string",
"description": "The primary ingestion URL that you should use to stream video to YouTube."
},
"backupIngestionAddress": {
"type": "string",
"description": "The backup ingestion URL that you should use to stream video to YouTube."
},
"rtmpsIngestionAddress": {
"type": "string",
"description": "The primary secured ingestion URL that you should use to stream video to YouTube."
},
"backupRtmpsIngestionAddress": {
"type": "string",
"description": "The backup secured ingestion URL that you should use to stream video to YouTube."
}
}
},
"resolution": {
"type": "string",
"description": "The resolution of the inbound video data."
},
"frameRate": {
"type": "string",
"description": "The frame rate of the inbound video data."
}
}
},
"status": {
"type": "object",
"description": "Status information about a live stream including its stream status and health status.",
"properties": {
"streamStatus": {
"type": "string",
"description": "The stream's current status.",
"enum": [
"active",
"created",
"error",
"inactive",
"ready"
]
},
"healthStatus": {
"type": "object",
"description": "The health status of the stream.",
"properties": {
"status": {
"type": "string",
"description": "The status code of this stream.",
"enum": [
"bad",
"good",
"noData",
"ok",
"revoked"
]
},
"lastUpdateTimeSeconds": {
"type": "integer",
"description": "The last time this status was updated, as a Unix timestamp."
},
"configurationIssues": {
"type": "array",
"description": "The configurations issues on this stream.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The kind of error happening."
},
"severity": {
"type": "string",
"description": "How severe this issue is to the stream.",
"enum": [
"error",
"info",
"warning"
]
},
"reason": {
"type": "string",
"description": "The short-form reason for this issue."
},
"description": {
"type": "string",
"description": "The long-form description of the issue and how to resolve it."
}
}
}
}
}
}
}
},
"contentDetails": {
"type": "object",
"description": "Detailed settings for a live stream including the stream key and ingestion settings.",
"properties": {
"boundBroadcastId": {
"type": "string",
"description": "The ID of the live broadcast to which this stream is bound."
},
"isReusable": {
"type": "boolean",
"description": "Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts."
}
}
}
},
"required": [
"kind",
"etag"
],
"$schema": "https://json-structure.org/draft/2020-12/schema"
}