Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.
data.object.object is live_stream.
Fields of data.object for live.started
Field
Type
Description
audio_ms required
integer
Milliseconds of audio received.
billed_ms required
integer
Milliseconds billed against the plan.
created_at required
string (date-time)
When the stream was created.
end_reason required
string | null
Why it ended: finalized, idle, stopped, revoked or failed; null while running.
id required
string
The live stream id.
language required
string
The spoken language.
last_seq required
integer
The last caption sequence number.
object required
enum: live_stream
Always live_stream.
public_captions required
boolean
True when captions are public.
source required
string
The stream source name.
status required
enum: created | live | reconnecting | ended | failed
Where the stream stands.
status_transitions required
object
When the stream reached each state.
deleted_at required
string (date-time) | null
When it was deleted.
disconnected_at required
string (date-time) | null
When the feed last dropped.
ended_at required
string (date-time) | null
When it ended.
started_at required
string (date-time) | null
When it began.
teaching required
object | null
The teaching created from the service, null until it exists.
id required
string
The teaching id.
name required
string
The teaching title, as every reference object names itself.
object required
enum: teaching
Always teaching.
recorded_at required
string (date-time) | null
When the teaching was recorded.
speaker required
string
The speaker, empty when unknown.
title required
string
The teaching title.
On updates, data.previous_attributes holds the earlier value of any of these that changed: status.
Carries contentThe feed dropped and the stream is waiting for the encoder to return.
Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.
data.object.object is live_stream.
Fields of data.object for live.reconnecting
Field
Type
Description
audio_ms required
integer
Milliseconds of audio received.
billed_ms required
integer
Milliseconds billed against the plan.
created_at required
string (date-time)
When the stream was created.
end_reason required
string | null
Why it ended: finalized, idle, stopped, revoked or failed; null while running.
id required
string
The live stream id.
language required
string
The spoken language.
last_seq required
integer
The last caption sequence number.
object required
enum: live_stream
Always live_stream.
public_captions required
boolean
True when captions are public.
source required
string
The stream source name.
status required
enum: created | live | reconnecting | ended | failed
Where the stream stands.
status_transitions required
object
When the stream reached each state.
deleted_at required
string (date-time) | null
When it was deleted.
disconnected_at required
string (date-time) | null
When the feed last dropped.
ended_at required
string (date-time) | null
When it ended.
started_at required
string (date-time) | null
When it began.
teaching required
object | null
The teaching created from the service, null until it exists.
id required
string
The teaching id.
name required
string
The teaching title, as every reference object names itself.
object required
enum: teaching
Always teaching.
recorded_at required
string (date-time) | null
When the teaching was recorded.
speaker required
string
The speaker, empty when unknown.
title required
string
The teaching title.
On updates, data.previous_attributes holds the earlier value of any of these that changed: status.
Carries contentA live stream ended, whether finished, stopped, idle, revoked or failed. status and end_reason say which.
Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.
data.object.object is live_stream.
Fields of data.object for live.ended
Field
Type
Description
audio_ms required
integer
Milliseconds of audio received.
billed_ms required
integer
Milliseconds billed against the plan.
created_at required
string (date-time)
When the stream was created.
end_reason required
string | null
Why it ended: finalized, idle, stopped, revoked or failed; null while running.
id required
string
The live stream id.
language required
string
The spoken language.
last_seq required
integer
The last caption sequence number.
object required
enum: live_stream
Always live_stream.
public_captions required
boolean
True when captions are public.
source required
string
The stream source name.
status required
enum: created | live | reconnecting | ended | failed
Where the stream stands.
status_transitions required
object
When the stream reached each state.
deleted_at required
string (date-time) | null
When it was deleted.
disconnected_at required
string (date-time) | null
When the feed last dropped.
ended_at required
string (date-time) | null
When it ended.
started_at required
string (date-time) | null
When it began.
teaching required
object | null
The teaching created from the service, null until it exists.
id required
string
The teaching id.
name required
string
The teaching title, as every reference object names itself.
object required
enum: teaching
Always teaching.
recorded_at required
string (date-time) | null
When the teaching was recorded.
speaker required
string
The speaker, empty when unknown.
title required
string
The teaching title.
On updates, data.previous_attributes holds the earlier value of any of these that changed: status.
Carries contentA finished live stream was deleted, with its captions, recordings and timeline. The teaching made from it is kept.
Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.
data.object.object is live_stream.
Fields of data.object for live.stream.deleted
Field
Type
Description
audio_ms required
integer
Milliseconds of audio received.
billed_ms required
integer
Milliseconds billed against the plan.
created_at required
string (date-time)
When the stream was created.
end_reason required
string | null
Why it ended: finalized, idle, stopped, revoked or failed; null while running.
id required
string
The live stream id.
language required
string
The spoken language.
last_seq required
integer
The last caption sequence number.
object required
enum: live_stream
Always live_stream.
public_captions required
boolean
True when captions are public.
source required
string
The stream source name.
status required
enum: created | live | reconnecting | ended | failed
Where the stream stands.
status_transitions required
object
When the stream reached each state.
deleted_at required
string (date-time) | null
When it was deleted.
disconnected_at required
string (date-time) | null
When the feed last dropped.
ended_at required
string (date-time) | null
When it ended.
started_at required
string (date-time) | null
When it began.
teaching required
object | null
The teaching created from the service, null until it exists.
id required
string
The teaching id.
name required
string
The teaching title, as every reference object names itself.
Carries contentA finished live service became a teaching with its captions as the transcript. teaching points to it.
Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.
data.object.object is live_stream.
Fields of data.object for live.teaching_created
Field
Type
Description
audio_ms required
integer
Milliseconds of audio received.
billed_ms required
integer
Milliseconds billed against the plan.
created_at required
string (date-time)
When the stream was created.
end_reason required
string | null
Why it ended: finalized, idle, stopped, revoked or failed; null while running.
id required
string
The live stream id.
language required
string
The spoken language.
last_seq required
integer
The last caption sequence number.
object required
enum: live_stream
Always live_stream.
public_captions required
boolean
True when captions are public.
source required
string
The stream source name.
status required
enum: created | live | reconnecting | ended | failed
Where the stream stands.
status_transitions required
object
When the stream reached each state.
deleted_at required
string (date-time) | null
When it was deleted.
disconnected_at required
string (date-time) | null
When the feed last dropped.
ended_at required
string (date-time) | null
When it ended.
started_at required
string (date-time) | null
When it began.
teaching required
object | null
The teaching created from the service, null until it exists.
id required
string
The teaching id.
name required
string
The teaching title, as every reference object names itself.