GCKCastOptions Class

  • GCKCastOptions are options that affect the discovery of Cast devices and the behavior of Cast sessions and must be set before being passed to GCKCastContext.

  • GCKCastOptions objects can be constructed with a specified receiver application ID or a list of supported namespaces.

  • Properties of GCKCastOptions include controlling volume with physical buttons, disabling automatic device discovery, setting receiver launch options, specifying a shared container identifier for background downloads, and suspending/resuming sessions when the application is backgrounded.

GCKCastOptions Class Reference

Overview

Options that affect the discovery of Cast devices and the behavior of Cast sessions.

Writable properties must be set before passing this object to the GCKCastContext.

Since
3.0

Inherits NSObject. Implements <NSCopying>.

Instance Method Summary

(instancetype) - initWithReceiverApplicationID:
 Constructs a new GCKCastOptions object with the specified receiver application ID. More...
 
(instancetype) - initWithSupportedNamespaces:
 Constructs a new GCKCastOptions object with the specified list of namespaces. More...
 

Property Summary

BOOL physicalVolumeButtonsWillControlDeviceVolume
 A flag indicating whether the sender device's physical volume buttons should control the session's volume. More...
 
BOOL disableDiscoveryAutostart
 A flag indicating whether the discovery of Cast devices should start automatically at context initialization time. More...
 
GCKLaunchOptionslaunchOptions
 The receiver launch options to use when starting a Cast session. More...
 
NSString * sharedContainerIdentifier
 The shared container identifier to use for background HTTP downloads that are performed by the framework. More...
 
BOOL suspendSessionsWhenBackgrounded
 Whether sessions should be suspended when the sender application goes into the background (and resumed when it returns to the foreground). More...
 

Method Detail

- (instancetype) initWithReceiverApplicationID: (NSString *)  applicationID

Constructs a new GCKCastOptions object with the specified receiver application ID.

Parameters
applicationIDThe ID of the receiver application which must be supported by discovered Cast devices, and which will be launched when starting a new Cast session.
- (instancetype) initWithSupportedNamespaces: (NSArray< NSString * > *)  namespaces

Constructs a new GCKCastOptions object with the specified list of namespaces.

Parameters
namespacesA list of namespaces which must be supported by the currently running receiver application on each discovered Cast device.

Property Detail

- (BOOL) physicalVolumeButtonsWillControlDeviceVolume
readwritenonatomicassign

A flag indicating whether the sender device's physical volume buttons should control the session's volume.

- (BOOL) disableDiscoveryAutostart
readwritenonatomicassign

A flag indicating whether the discovery of Cast devices should start automatically at context initialization time.

If set to NO, discovery can be started and stopped on-demand by using the methods startDiscovery (GCKDiscoveryManager) and stopDiscovery (GCKDiscoveryManager).

Since
3.4
- (GCKLaunchOptions*) launchOptions
readwritenonatomiccopy

The receiver launch options to use when starting a Cast session.

- (NSString*) sharedContainerIdentifier
readwritenonatomiccopy

The shared container identifier to use for background HTTP downloads that are performed by the framework.

Since
3.2
- (BOOL) suspendSessionsWhenBackgrounded
readwritenonatomicassign

Whether sessions should be suspended when the sender application goes into the background (and resumed when it returns to the foreground).

By default this option is set to YES. It is appropriate to set this to NO in applications that are able to maintain network connections indefinitely while in the background.

Since
3.4