GCKCastContext(UI) Category

  • The GCKCastContext(UI) category provides UI-specific APIs for the GCKCastContext class.

  • It includes methods for displaying the Cast dialog and presenting instructional view controllers.

  • The category also offers properties for managing image caching and selection for media metadata.

  • You can configure the framework's behavior for presenting expanded media controls using the useDefaultExpandedMediaControls property.
Instance Methods | Properties
GCKCastContext(UI) Category Reference

Overview

A category on GCKCastContext containing UI-specific APIs.

Since
3.0

Instance Method Summary

(void) - presentCastDialog
 Displays the Cast dialog. More...
 
(GCKUICastContainerViewController *) - createCastContainerControllerForViewController:
 Constructs a GCKUICastContainerViewController that embeds the given view controller. More...
 
(GCKUIMiniMediaControlsViewController *) - createMiniMediaControlsViewController
 Constructs a GCKUIMiniMediaControlsViewController. More...
 
(BOOL) - presentCastInstructionsViewControllerOnce
 If it has not been shown before, presents a fullscreen modal view controller that calls attention to the Cast button and displays some brief instructional text about its use. More...
 
(BOOL) - presentCastInstructionsViewControllerOnceWithCastButton:
 If it has not been shown before, presents a fullscreen modal view controller that calls attention to the Cast button, whose view is passed in, and displays some brief instructional text about its use. More...
 
(void) - clearCastInstructionsShownFlag
 Clears the persistent flag that tracks whether the Cast instructions modal view controller has been shown. More...
 
(void) - presentDefaultExpandedMediaControls
 Displays the default Cast expanded media controls. More...
 

Property Summary

id< GCKUIImageCache > imageCache
 The image cache implementation that will be used by the framework to fetch images that are referenced in media metadata. More...
 
id< GCKUIImagePicker > imagePicker
 The image picker implementation that will be used to select an image for a specific purpose. More...
 
BOOL useDefaultExpandedMediaControls
 Configures the behavior of the framework when there's a user action that should result in the presentation of the expanded controls. More...
 
GCKUIExpandedMediaControlsViewController * defaultExpandedMediaControlsViewController
 The instance of the default Cast expanded media controls view controller. More...
 

Method Detail

- (void) presentCastDialog

Displays the Cast dialog.

Extends class GCKCastContext.

- (GCKUICastContainerViewController *) createCastContainerControllerForViewController: (UIViewController *)  viewController

Constructs a GCKUICastContainerViewController that embeds the given view controller.

Extends class GCKCastContext.

- (GCKUIMiniMediaControlsViewController *) createMiniMediaControlsViewController

Constructs a GCKUIMiniMediaControlsViewController.

Extends class GCKCastContext.

- (BOOL) presentCastInstructionsViewControllerOnce

If it has not been shown before, presents a fullscreen modal view controller that calls attention to the Cast button and displays some brief instructional text about its use.

Returns
YES if the view controller was shown, NO if it was not shown because it had already been shown before. Since version 4.1, NO is also returned if the Cast Button was not found.
Deprecated:
Use presentCastInstructionsViewControllerOnceWithCastButton:.

Extends class GCKCastContext.

- (BOOL) presentCastInstructionsViewControllerOnceWithCastButton: (GCKUICastButton *)  castButton

If it has not been shown before, presents a fullscreen modal view controller that calls attention to the Cast button, whose view is passed in, and displays some brief instructional text about its use.

Returns
YES if the view controller was shown, NO if it was not shown because it had already been shown before. NO is also returned if the Cast Button was not found.
Since
4.1

Extends class GCKCastContext.

- (void) clearCastInstructionsShownFlag

Clears the persistent flag that tracks whether the Cast instructions modal view controller has been shown.

Extends class GCKCastContext.

- (void) presentDefaultExpandedMediaControls

Displays the default Cast expanded media controls.

Extends class GCKCastContext.

Property Detail

- (id<GCKUIImageCache>) imageCache
readwritenonatomicstrong

The image cache implementation that will be used by the framework to fetch images that are referenced in media metadata.

A default implementation will be used if one is not provided by the application. May be set to nil to reinstate the default image cache.

Extends class GCKCastContext.

- (id<GCKUIImagePicker>) imagePicker
readwritenonatomicstrong

The image picker implementation that will be used to select an image for a specific purpose.

A default implementation will be used if one is not provided by the application. May be set to nil to reinstate the default image picker.

Extends class GCKCastContext.

- (BOOL) useDefaultExpandedMediaControls
readwritenonatomicassign

Configures the behavior of the framework when there's a user action that should result in the presentation of the expanded controls.

If YES, the framework will present the default expaned controls view. If NO, the framework will just trigger a GCKCastContext::kGCKExpandedMediaControlsTriggeredNotification.

Extends class GCKCastContext.

- (GCKUIExpandedMediaControlsViewController*) defaultExpandedMediaControlsViewController
readnonatomicstrong

The instance of the default Cast expanded media controls view controller.

Extends class GCKCastContext.