GCKCastOptions Class

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, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary

(instancetype) - initWithDiscoveryCriteria:
 Constructs a new GCKCastOptions object with the specified discovery criteria. More...
 
(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...
 
BOOL disableAnalyticsLogging
 A flag which is used to disable or enable collection of diagnostic data to improve the reliability of Cast device discovery. 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...
 
BOOL stopReceiverApplicationWhenEndingSession
 Whether the receiver application should be terminated when the user ends the session via the "Stop Casting" button. More...
 

Method Detail

- (instancetype) initWithDiscoveryCriteria: (GCKDiscoveryCriteria *)  discoveryCriteria

Constructs a new GCKCastOptions object with the specified discovery criteria.

Parameters
discoveryCriteriaThe discovery criteria to apply to discovered Cast devices. Only those devices that satisfy the criteria will be made available to the application.
Since
4.0
- (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.
Deprecated:
Use initWithDiscoveryCriteria:.
- (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.
Deprecated:
Use initWithDiscoveryCriteria:.

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
- (BOOL) disableAnalyticsLogging
readwritenonatomicassign

A flag which is used to disable or enable collection of diagnostic data to improve the reliability of Cast device discovery.

The default value is NO (enabled); it may be disabled by setting the value to YES.

Since
4.0
- (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
- (BOOL) stopReceiverApplicationWhenEndingSession
readwritenonatomicassign

Whether the receiver application should be terminated when the user ends the session via the "Stop Casting" button.

By default this option is set to NO.

Since
4.0