Clase GCKCastSession

Referencia de la clase GCKCastSession

Descripción general

Es una clase que administra una sesión de transmisión con un dispositivo receptor.

GCKSessionManager crea y administra las sesiones automáticamente. La aplicación no debe llamar directamente a los métodos de ciclo de vida de la sesión, como start (GCKSession(Protected)) o endWithAction: (GCKSession(Protected)).

Since
3.0

Hereda GCKSession.

Resumen del método de instancia

(instancetype) - initWithDevice:sessionID:sessionOptions:castOptions:
 Crea una nueva sesión de transmisión con las opciones de transmisión determinadas. Más...
 
(BOOL) - addChannel:
 Registra un canal con la sesión. Más...
 
(BOOL) - removeChannel:
 Quita de la sesión un canal registrado anteriormente. Más...
 
(void) - addDeviceStatusListener:
 Agrega un GCKCastDeviceStatusListener a la lista de objetos de escucha de este objeto. Más...
 
(void) - removeDeviceStatusListener:
 Quita un GCKCastDeviceStatusListener de la lista de objetos de escucha de este objeto. Más...
 
(GCKRequest *) - setDeviceVolume:forMultizoneDevice:
 Establece el volumen del dispositivo individual en un grupo multizona. Más...
 
(GCKRequest *) - setDeviceMuted:forMultizoneDevice:
 Establece el estado silenciado del dispositivo individual en un grupo multizona. Más...
 
(GCKRequest *) - requestMultizoneStatus
 Solicita el estado multizona de un grupo multizona. Más...
 
(instancetype) - initWithDevice:traits:sessionID:
 Inicializa un objeto de sesión nuevo para el dispositivo determinado, con las opciones predeterminadas. Más...
 
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
 Inicializa un objeto de sesión nuevo para el dispositivo determinado. Más...
 
(GCKRequest *) - setDeviceVolume:
 Establece el volumen del dispositivo. Más...
 
(GCKRequest *) - setDeviceMuted:
 Establece el estado de silencio del dispositivo. Más...
 
(void) - start
 Inicia la sesión. Más...
 
(void) - endWithAction:
 Finaliza la sesión con la acción especificada. Más...
 
(void) - notifyDidStartWithSessionID:
 Lo llaman las subclases para notificar al framework que se inició la sesión. Más...
 
(void) - notifyDidFailToStartWithError:
 Lo llaman las subclases para notificar al framework que la sesión no se inició. Más...
 
(void) - notifyDidEndWithError:willTryToResume:
 Lo llaman las subclases para notificar al framework que la sesión finalizó. Más...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 Lo llaman las subclases para notificar al marco de trabajo que el dispositivo actualizó el volumen y el estado de silencio del dispositivo. Más...
 
(void) - notifyDidReceiveDeviceStatus:
 Lo llaman las subclases para notificar al framework que se recibió el estado actualizado del dispositivo. Más...
 
(void) - notifyDidSuspendWithReason:
 Este campo es obsoleto, no se debe usar: se implementó como no-op. Más...
 
(void) - notifyDidResume
 Este campo es obsoleto, no se debe usar: se implementó como no-op. Más...
 

Resumen de la propiedad

GCKActiveInputStatus activeInputStatus
 El estado actual de "entrada activa" del dispositivo. Más...
 
GCKStandbyStatus standbyStatus
 El estado actual "En espera" del dispositivo. Más...
 
GCKApplicationMetadataapplicationMetadata
 Los metadatos de la aplicación receptora que se está ejecutando en el dispositivo receptor, si hubiera alguno; de lo contrario, nil. Más...
 
GCKDevicedevice
 El dispositivo con el que está asociada esta sesión. Más...
 
NSString * sessionID
 El ID de sesión actual, si existe. Más...
 
GCKSessionOptions * sessionOptions
 Las opciones de sesión, si las hubiera. Más...
 
GCKConnectionState connectionState
 Es el estado actual de la conexión de la sesión. Más...
 
BOOL suspended
 Indica si la sesión está suspendida. Más...
 
NSString * deviceStatusText
 Texto actual del estado del dispositivo Más...
 
GCKSessionTraitstraits
 Las características de la sesión. Más...
 
float currentDeviceVolume
 El volumen de dispositivo actual, en el rango [0.0, 1.0]. Más...
 
BOOL currentDeviceMuted
 Estado actual del dispositivo silenciado. Más...
 
GCKRemoteMediaClientremoteMediaClient
 El objeto GCKRemoteMediaClient que se puede usar para controlar la reproducción de contenido multimedia en esta sesión. Más...
 
GCKMediaMetadatamediaMetadata
 Los metadatos de medios actuales, si los hubiera. Más...
 

Detalle del método

- (instancetype) initWithDevice: (GCKDevice *)  device
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions
castOptions: (GCKCastOptions *)  castOptions 

Crea una nueva sesión de transmisión con las opciones de transmisión determinadas.

Parameters
deviceThe receiver device.
sessionIDThe session ID, if resuming; otherwise nil.
sessionOptionsThe session options, if any; otherwise nil.
castOptionsThe Cast options.
Since
4.0
- (BOOL) addChannel: (GCKCastChannel *)  channel

Registra un canal con la sesión.

Si la sesión está conectada y la aplicación receptora admite el espacio de nombres del canal, el canal se conectará automáticamente. Si la sesión no está conectada, el canal permanecerá desconectado hasta que se inicie la sesión.

Parameters
channelThe channel to register.
Resultado que se muestra
YES si el canal se registró correctamente, de lo contrario, NO.
- (BOOL) removeChannel: (GCKCastChannel *)  channel

Quita de la sesión un canal registrado anteriormente.

Parameters
channelThe channel to unregister.
Resultado que se muestra
YES si se anuló correctamente el registro del canal, de lo contrario, NO.
- (void) addDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Agrega un GCKCastDeviceStatusListener a la lista de objetos de escucha de este objeto.

El objeto de escucha agregado se retiene de manera débil y debe retenerse para evitar la desasignación inesperada.

Parameters
listenerThe listener to add.
- (void) removeDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Quita un GCKCastDeviceStatusListener de la lista de objetos de escucha de este objeto.

Parameters
listenerThe listener to remove.
- (GCKRequest *) setDeviceVolume: (float)  volume
forMultizoneDevice: (GCKMultizoneDevice *)  device 

Establece el volumen del dispositivo individual en un grupo multizona.

Esta es una operación asíncrona.

Parameters
volumeThe new volume, in the range [0.0, 1.0].
deviceThe multizone device.
Resultado que se muestra
Es un objeto GCKRequest para realizar un seguimiento de la solicitud.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted
forMultizoneDevice: (GCKMultizoneDevice *)  device 

Establece el estado silenciado del dispositivo individual en un grupo multizona.

Esta es una operación asíncrona.

Parameters
mutedThe new muted state.
deviceThe multizone device.
Resultado que se muestra
Es un objeto GCKRequest para realizar un seguimiento de la solicitud.
- (GCKRequest *) requestMultizoneStatus

Solicita el estado multizona de un grupo multizona.

Esta es una operación asíncrona. Cuando se reciba el estado multizona, se enviará un mensaje al método de delegado castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p).

Resultado que se muestra
Es un objeto GCKRequest para realizar un seguimiento de la solicitud.
- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID 

Inicializa un objeto de sesión nuevo para el dispositivo determinado, con las opciones predeterminadas.

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions 

Inicializa un objeto de sesión nuevo para el dispositivo determinado.

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
sessionOptionsThe session options, if any; otherwise nil.
Since
4.0
- (GCKRequest *) setDeviceVolume: (float)  volume

Establece el volumen del dispositivo.

Esta es una operación asíncrona. La implementación predeterminada es una no-op que falla la solicitud con un error GCKErrorCodeUnsupportedFeature.

Parameters
volumeThe new volume.
Resultado que se muestra
Es un objeto GCKRequest para realizar un seguimiento de la solicitud.
Since
3.4; en versiones anteriores del marco de trabajo, este método mostraba void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

Establece el estado de silencio del dispositivo.

Esta es una operación asíncrona. La implementación predeterminada es una no-op que falla la solicitud con un error GCKErrorCodeUnsupportedFeature.

Parameters
mutedThe new mute state.
Resultado que se muestra
Es un objeto GCKRequest para realizar un seguimiento de la solicitud.
Since
3.4; en versiones anteriores del marco de trabajo, este método mostraba void.
- (void) start

Inicia la sesión.

Esta es una operación asíncrona. Deben ser anuladas por subclases.

Proporcionado por la categoría GCKSession(Protected).

- (void) endWithAction: (GCKSessionEndAction action

Finaliza la sesión con la acción especificada.

Esta es una operación asíncrona. Deben ser anuladas por subclases.

Parameters
actionThe action to take when ending the session; see GCKSessionEndAction for more details.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Lo llaman las subclases para notificar al framework que se inició la sesión.

Parameters
sessionIDThe session's unique ID.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (NSError *)  error

Lo llaman las subclases para notificar al framework que la sesión no se inició.

Parameters
errorThe error that occurred.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidEndWithError: (nullable NSError *)  error
willTryToResume: (BOOL)  willTryToResume 

Lo llaman las subclases para notificar al framework que la sesión finalizó.

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.
willTryToResumeWhether the session will try to resume itself automatically.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidReceiveDeviceVolume: (float)  volume
muted: (BOOL)  muted 

Lo llaman las subclases para notificar al marco de trabajo que el dispositivo actualizó el volumen y el estado de silencio del dispositivo.

Parameters
volumeThe device's current volume. Must be in the range [0, 1.0];
mutedThe device's current mute state.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidReceiveDeviceStatus: (nullable NSString *)  statusText

Lo llaman las subclases para notificar al framework que se recibió el estado actualizado del dispositivo.

Parameters
statusTextThe new status.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

Este campo es obsoleto, no lo uses, ya que se implementa como no-op.

Deprecated:
No llames.

Proporcionado por la categoría GCKSession(Protected).

- (void) notifyDidResume

Este campo es obsoleto, no lo uses, ya que se implementa como no-op.

Deprecated:
No llames.

Proporcionado por la categoría GCKSession(Protected).

Detalles de la propiedad

- (GCKActiveInputStatus) activeInputStatus
readnonatomicassign

El estado actual de "entrada activa" del dispositivo.

- (GCKStandbyStatus) standbyStatus
readnonatomicassign

El estado actual "En espera" del dispositivo.

- (GCKApplicationMetadata*) applicationMetadata
readnonatomiccopy

Los metadatos de la aplicación receptora que se está ejecutando en el dispositivo receptor, si hubiera alguno; de lo contrario, nil.

- (GCKDevice*) device
readnonatomicstronginherited

El dispositivo con el que está asociada esta sesión.

- (NSString*) sessionID
readnonatomiccopyinherited

El ID de sesión actual, si existe.

- (GCKSessionOptions*) sessionOptions
readnonatomicstronginherited

Las opciones de sesión, si las hubiera.

Since
4.0
- (GCKConnectionState) connectionState
readnonatomicassigninherited

Es el estado actual de la conexión de la sesión.

- (BOOL) suspended
readnonatomicassigninherited

Indica si la sesión está suspendida.

Deprecated:
GCKSession ya no admite el estado suspendido. Si es necesario, mueve esta funcionalidad a una subclase.
- (NSString*) deviceStatusText
readnonatomiccopyinherited

Texto actual del estado del dispositivo

- (GCKSessionTraits*) traits
readnonatomiccopyinherited

Las características de la sesión.

- (float) currentDeviceVolume
readnonatomicassigninherited

El volumen de dispositivo actual, en el rango [0.0, 1.0].

- (BOOL) currentDeviceMuted
readnonatomicassigninherited

Estado actual del dispositivo silenciado.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstronginherited

El objeto GCKRemoteMediaClient que se puede usar para controlar la reproducción de contenido multimedia en esta sesión.

Es nil antes de que comience la sesión o si esta no admite la API de GCKRemoteMediaClient. Las subclases que proporcionan una interfaz GCKRemoteMediaClient deben anular el método captador.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstronginherited

Los metadatos de medios actuales, si los hubiera.

Será nil si la sesión no admite el espacio de nombres multimedia o si no hay ningún contenido multimedia cargado actualmente en el receptor.