YouTubePHP Documentation

LiveBroadcastStatus extends Part
in package

This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.

Live broadcast state.

Tags
since
1.0.0

Table of Contents

Constants

LIFE_CYCLE_STATUS_COMPLETE  : mixed = 'complete'
The broadcast is finished.
LIFE_CYCLE_STATUS_CREATED  : mixed = 'created'
Incomplete settings, but otherwise valid
LIFE_CYCLE_STATUS_LIFE_CYCLE_STATUS_UNSPECIFIED  : mixed = 'lifeCycleStatusUnspecified'
No value or the value is unknown.
LIFE_CYCLE_STATUS_LIVE  : mixed = 'live'
Viper is recording; this means the "clock" is running
LIFE_CYCLE_STATUS_LIVE_STARTING  : mixed = 'liveStarting'
Transition into LIVE has been requested
LIFE_CYCLE_STATUS_READY  : mixed = 'ready'
Complete settings
LIFE_CYCLE_STATUS_REVOKED  : mixed = 'revoked'
This broadcast was removed by admin action
LIFE_CYCLE_STATUS_TEST_STARTING  : mixed = 'testStarting'
Transition into TESTING has been requested
LIFE_CYCLE_STATUS_TESTING  : mixed = 'testing'
Visible only to partner, may need special UI treatment
LIVE_BROADCAST_PRIORITY_HIGH  : mixed = 'high'
High priority broadcast: for high profile HoAs, like PixelCorp ones.
LIVE_BROADCAST_PRIORITY_LIVE_BROADCAST_PRIORITY_UNSPECIFIED  : mixed = 'liveBroadcastPriorityUnspecified'
A `liveBroadcastPriority` of `liveBroadcastPriorityUnspecified`.
LIVE_BROADCAST_PRIORITY_LOW  : mixed = 'low'
Low priority broadcast: for low view count HoAs or other low priority broadcasts.
LIVE_BROADCAST_PRIORITY_NORMAL  : mixed = 'normal'
Normal priority broadcast: for regular HoAs and broadcasts.
PRIVACY_STATUS_PRIVATE  : mixed = 'private'
A `privacyStatus` of `private`.
PRIVACY_STATUS_PUBLIC  : mixed = 'public'
A `privacyStatus` of `public`.
PRIVACY_STATUS_UNLISTED  : mixed = 'unlisted'
A `privacyStatus` of `unlisted`.
RECORDING_STATUS_LIVE_BROADCAST_RECORDING_STATUS_UNSPECIFIED  : mixed = 'liveBroadcastRecordingStatusUnspecified'
No value or the value is unknown.
RECORDING_STATUS_NOT_RECORDING  : mixed = 'notRecording'
The recording has not yet been started.
RECORDING_STATUS_RECORDED  : mixed = 'recorded'
The recording is completed, and cannot be started again.
RECORDING_STATUS_RECORDING  : mixed = 'recording'
The recording is currently on.

Properties

$lifeCycleStatus  : string|null
$liveBroadcastPriority  : string|null
$madeForKids  : bool|null
$privacyStatus  : string|null
$recordingStatus  : string|null
$selfDeclaredMadeForKids  : bool|null
$casts  : array<string, string>
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
$dates  : array<int, string>
Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
$youtube  : ?YouTube

Methods

__construct()  : mixed
__debugInfo()  : array<string, mixed>
__get()  : mixed
__isset()  : bool
__set()  : void
__toString()  : string
__unset()  : void
attributeExists()  : bool
fill()  : void
getAttribute()  : mixed
getCasts()  : array<string, string>
getDates()  : array<int, string>
getRawAttribute()  : mixed
Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
getRawAttributes()  : array<string, mixed>
getYouTube()  : YouTube
The client this part came from.
jsonSerialize()  : array<string, mixed>
The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
setAttribute()  : void
factory()  : Factory
Builds another part from the same client - for nested objects.
setRawAttribute()  : void
Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.

Constants

LIFE_CYCLE_STATUS_COMPLETE

The broadcast is finished.

public mixed LIFE_CYCLE_STATUS_COMPLETE = 'complete'

LIFE_CYCLE_STATUS_CREATED

Incomplete settings, but otherwise valid

public mixed LIFE_CYCLE_STATUS_CREATED = 'created'

LIFE_CYCLE_STATUS_LIFE_CYCLE_STATUS_UNSPECIFIED

No value or the value is unknown.

public mixed LIFE_CYCLE_STATUS_LIFE_CYCLE_STATUS_UNSPECIFIED = 'lifeCycleStatusUnspecified'

LIFE_CYCLE_STATUS_LIVE

Viper is recording; this means the "clock" is running

public mixed LIFE_CYCLE_STATUS_LIVE = 'live'

LIFE_CYCLE_STATUS_LIVE_STARTING

Transition into LIVE has been requested

public mixed LIFE_CYCLE_STATUS_LIVE_STARTING = 'liveStarting'

LIFE_CYCLE_STATUS_READY

Complete settings

public mixed LIFE_CYCLE_STATUS_READY = 'ready'

LIFE_CYCLE_STATUS_REVOKED

This broadcast was removed by admin action

public mixed LIFE_CYCLE_STATUS_REVOKED = 'revoked'

LIFE_CYCLE_STATUS_TEST_STARTING

Transition into TESTING has been requested

public mixed LIFE_CYCLE_STATUS_TEST_STARTING = 'testStarting'

LIFE_CYCLE_STATUS_TESTING

Visible only to partner, may need special UI treatment

public mixed LIFE_CYCLE_STATUS_TESTING = 'testing'

LIVE_BROADCAST_PRIORITY_HIGH

High priority broadcast: for high profile HoAs, like PixelCorp ones.

public mixed LIVE_BROADCAST_PRIORITY_HIGH = 'high'

LIVE_BROADCAST_PRIORITY_LIVE_BROADCAST_PRIORITY_UNSPECIFIED

A `liveBroadcastPriority` of `liveBroadcastPriorityUnspecified`.

public mixed LIVE_BROADCAST_PRIORITY_LIVE_BROADCAST_PRIORITY_UNSPECIFIED = 'liveBroadcastPriorityUnspecified'

LIVE_BROADCAST_PRIORITY_LOW

Low priority broadcast: for low view count HoAs or other low priority broadcasts.

public mixed LIVE_BROADCAST_PRIORITY_LOW = 'low'

LIVE_BROADCAST_PRIORITY_NORMAL

Normal priority broadcast: for regular HoAs and broadcasts.

public mixed LIVE_BROADCAST_PRIORITY_NORMAL = 'normal'

PRIVACY_STATUS_PRIVATE

A `privacyStatus` of `private`.

public mixed PRIVACY_STATUS_PRIVATE = 'private'

PRIVACY_STATUS_PUBLIC

A `privacyStatus` of `public`.

public mixed PRIVACY_STATUS_PUBLIC = 'public'

PRIVACY_STATUS_UNLISTED

A `privacyStatus` of `unlisted`.

public mixed PRIVACY_STATUS_UNLISTED = 'unlisted'

RECORDING_STATUS_LIVE_BROADCAST_RECORDING_STATUS_UNSPECIFIED

No value or the value is unknown.

public mixed RECORDING_STATUS_LIVE_BROADCAST_RECORDING_STATUS_UNSPECIFIED = 'liveBroadcastRecordingStatusUnspecified'

RECORDING_STATUS_NOT_RECORDING

The recording has not yet been started.

public mixed RECORDING_STATUS_NOT_RECORDING = 'notRecording'

RECORDING_STATUS_RECORDED

The recording is completed, and cannot be started again.

public mixed RECORDING_STATUS_RECORDED = 'recorded'

RECORDING_STATUS_RECORDING

The recording is currently on.

public mixed RECORDING_STATUS_RECORDING = 'recording'

Properties

$lifeCycleStatus

public string|null $lifeCycleStatus

The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method. One of the LIFE_CYCLE_STATUS_* constants.

$liveBroadcastPriority

public string|null $liveBroadcastPriority

Priority of the live broadcast event (internal state). One of the LIVE_BROADCAST_PRIORITY_* constants.

$madeForKids

public bool|null $madeForKids

Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

$privacyStatus

public string|null $privacyStatus

The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource. One of the PRIVACY_STATUS_* constants.

$recordingStatus

public string|null $recordingStatus

The broadcast's recording status. One of the RECORDING_STATUS_* constants.

$selfDeclaredMadeForKids

public bool|null $selfDeclaredMadeForKids

This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

$casts

Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.

protected array<string, string> $casts = []

$dates

Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.

protected array<int, string> $dates = []

Methods

__construct()

public __construct([YouTube|null $youtube = null ][, array<string, mixed>|object $attributes = [] ]) : mixed
Parameters
$youtube : YouTube|null = null

The client, for behaviour that calls the API.

$attributes : array<string, mixed>|object = []

__debugInfo()

public __debugInfo() : array<string, mixed>
Return values
array<string, mixed>

__get()

public __get(string $name) : mixed
Parameters
$name : string

__isset()

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

__set()

public __set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

__toString()

public __toString() : string
Return values
string

__unset()

public __unset(string $name) : void
Parameters
$name : string

attributeExists()

public attributeExists(string $key) : bool
Parameters
$key : string
Return values
bool

fill()

public fill(array<string, mixed> $attributes) : void
Parameters
$attributes : array<string, mixed>

getAttribute()

public getAttribute(string $key) : mixed
Parameters
$key : string

getCasts()

public getCasts() : array<string, string>
Return values
array<string, string>

getDates()

public getDates() : array<int, string>
Return values
array<int, string>

getRawAttribute()

Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.

public getRawAttribute(string $key) : mixed
Parameters
$key : string

getRawAttributes()

public getRawAttributes() : array<string, mixed>
Return values
array<string, mixed>

getYouTube()

The client this part came from.

public getYouTube() : YouTube
Tags
throws
LogicException

When the part was built without one.

Return values
YouTube

jsonSerialize()

The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

setAttribute()

public setAttribute(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed

factory()

Builds another part from the same client - for nested objects.

protected factory() : Factory
Return values
Factory

setRawAttribute()

Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.

protected setRawAttribute(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
On this page

Search results