GCKCastOptions Class

    Instance Methods | Properties
    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...
    GCKLaunchOptions * 
    launchOptions
    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...
    BOOL 
    startDiscoveryAfterFirstTapOnCastButton
    Whether cast devices discovery start only after a user taps on the GCKUICastButton the first time. More...

    Method Detail

    - (instancetype) initWithDiscoveryCriteria: ( GCKDiscoveryCriteria *)  discoveryCriteria

    Constructs a new GCKCastOptions object with the specified discovery criteria.

    Parameters
    discoveryCriteria
    The 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
    applicationID
    The 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
    namespaces
    A 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
    read write nonatomic assign

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

    - (BOOL) disableDiscoveryAutostart
    read write nonatomic assign

    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) . By default this option is set to NO .

    Since
    3.4
    - (BOOL) disableAnalyticsLogging
    read write nonatomic assign

    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
    read write nonatomic copy

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

    - (NSString*) sharedContainerIdentifier
    read write nonatomic copy

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

    Since
    3.2
    - (BOOL) suspendSessionsWhenBackgrounded
    read write nonatomic assign

    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
    read write nonatomic assign

    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
    - (BOOL) startDiscoveryAfterFirstTapOnCastButton
    read write nonatomic assign

    Whether cast devices discovery start only after a user taps on the GCKUICastButton the first time.

    If set to YES , GCKUICastButton is displayed until a user taps on the cast button the first time. On the first tap, an interstitial is presented to explain why local network access permission is required for the cast to work. Discovery starts once the interstitial is dismissed. The cast button is shown again only when the device is connected to a Wi-Fi network. When a Wi-Fi network connection is not present, the cast button is hidden. If set to NO , discovery starts based on the flag disableDiscoveryAutoStart . This flag comes into effect only on iOS 14 and above if the flag disableDiscoveryAutoStart is set to NO . Default value is YES .

    Since
    4.5.3
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: