cast.receiver. system
Cast receiver system namespace.
Classes
ApplicationData
Represents the data of the launched application.
Sender
Represents the data of a connected sender device.
SystemVolumeData
Represents the system volume data.
Enumerations
DisconnectReason
string
Represents the disconnect reason.
Value |
|
|---|---|
|
REQUESTED_BY_SENDER |
Connection close was actively requested by the sender application (usually triggered by the user). |
|
ERROR |
There was a protocol error. |
|
UNKNOWN |
It is unknown if the sender requested to disconnect gracefully calling close (most likely it didn't, but the close message could have been lost). This normally happens when there is a network timeout or if the sender application crashes or if the sender OS closes the socket. |
LaunchedFrom
string
Represent where the receiver was launched from.
Value |
|
|---|---|
|
UNKNOWN |
The launch owner could not be determined. |
|
DIAL |
App was launched by DIAL request. |
|
CAST |
App was launched by Cast V2 request. |
|
CLOUD |
App was launched by assistant request (e.g. voice command). |
StandbyState
string
Represents the current standby state reported by the platform. It may be UNKNOWN if the cast platform was unable to determine the state yet.
Value |
|
|---|---|
|
STANDBY |
|
|
NOT_STANDBY |
|
|
UNKNOWN |
|
SystemState
string
Represents the current system state.
Value |
|
|---|---|
|
NOT_STARTED |
The application has not been requested to start yet. |
|
STARTING_IN_BACKGROUND |
Application is starting but it is in background. |
|
STARTING |
Application is starting. |
|
READY |
Application is ready to send and receive messages and it is in foreground. |
|
STOPPING_IN_BACKGROUND |
Application is stopping but it is in background. |
|
STOPPING |
Application is stopping. |
VisibilityState
string
Represents the current visibility state reported by the platform. It may be UNKNOWN if the cast platform was unable to determine the state yet.
Value |
|
|---|---|
|
VISIBLE |
|
|
NOT_VISIBLE |
|
|
UNKNOWN |
|
Properties
DisconnectReason
string
Represents the disconnect reason.
Value |
|
|---|---|
|
REQUESTED_BY_SENDER |
Connection close was actively requested by the sender application (usually triggered by the user). |
|
ERROR |
There was a protocol error. |
|
UNKNOWN |
It is unknown if the sender requested to disconnect gracefully calling close (most likely it didn't, but the close message could have been lost). This normally happens when there is a network timeout or if the sender application crashes or if the sender OS closes the socket. |
LaunchedFrom
string
Represent where the receiver was launched from.
Value |
|
|---|---|
|
UNKNOWN |
The launch owner could not be determined. |
|
DIAL |
App was launched by DIAL request. |
|
CAST |
App was launched by Cast V2 request. |
|
CLOUD |
App was launched by assistant request (e.g. voice command). |
NAMESPACE_PREFIX
string
The namespace prefix.
StandbyState
string
Represents the current standby state reported by the platform. It may be UNKNOWN if the cast platform was unable to determine the state yet.
Value |
|
|---|---|
|
STANDBY |
|
|
NOT_STANDBY |
|
|
UNKNOWN |
|
SystemState
string
Represents the current system state.
Value |
|
|---|---|
|
NOT_STARTED |
The application has not been requested to start yet. |
|
STARTING_IN_BACKGROUND |
Application is starting but it is in background. |
|
STARTING |
Application is starting. |
|
READY |
Application is ready to send and receive messages and it is in foreground. |
|
STOPPING_IN_BACKGROUND |
Application is stopping but it is in background. |
|
STOPPING |
Application is stopping. |
VisibilityState
string
Represents the current visibility state reported by the platform. It may be UNKNOWN if the cast platform was unable to determine the state yet.
Value |
|
|---|---|
|
VISIBLE |
|
|
NOT_VISIBLE |
|
|
UNKNOWN |
|