A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_cast_session below:

GCKCastSession Class | Google for Developers

Skip to main content GCKCastSession Class

Stay organized with collections Save and categorize content based on your preferences.

A class that manages a Cast session with a receiver device.

Sessions are created and managed automatically by the GCKSessionManager. The application should not directly call the session lifecycle methods such as start (GCKSession(Protected)) or endWithAction: (GCKSession(Protected)).

Since
3.0

Inherits GCKSession.

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

Constructs a new Cast session with the given Cast options.

Parameters
device The receiver device. sessionID The session ID, if resuming; otherwise nil. sessionOptions The session options, if any; otherwise nil. castOptions The Cast options.
Since
4.0

Registers a channel with the session.

If the session is connected and the receiver application supports the channel's namespace, the channel will be automatically connected. If the session is not connected, the channel will remain in a disconnected state until the session is started.

Parameters
channel The channel to register.
Returns
YES if the channel was registered successfully, NO otherwise.

Removes a previously registered channel from the session.

Parameters
channel The channel to unregister.
Returns
YES if the channel was unregistered successfully, NO otherwise.

Adds a GCKCastDeviceStatusListener to this object's list of listeners.

The added listener is weakly held, and should be retained to avoid unexpected deallocation.

Parameters
listener The listener to add.

Sets the individual device's volume in a multizone group.

This is an asynchronous operation.

Parameters
volume The new volume, in the range [0.0, 1.0]. device The multizone device.
Returns
A GCKRequest object for tracking the request.

Sets the individual device's muted state in a multizone group.

This is an asynchronous operation.

Parameters
muted The new muted state. device The multizone device.
Returns
A GCKRequest object for tracking the request.
- (instancetype) initWithDevice: (GCKDevice *)  device traits: (nullable GCKSessionTraits *)  traits sessionID: (nullable NSString *)  sessionID 

Initializes a new session object for the given device, with default options.

Parameters
device The device. traits The session traits. sessionID The 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 

Initializes a new session object for the given device.

Parameters
device The device. traits The session traits. sessionID The 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. sessionOptions The session options, if any; otherwise nil.
Since
4.0

Sets the device's volume.

This is an asynchronous operation. The default implementation is a no-op that fails the request with a GCKErrorCodeUnsupportedFeature error.

Parameters
Returns
A GCKRequest object for tracking the request.
Since
3.4; in previous framework versions, this method returned void.

Sets the device's mute state.

This is an asynchronous operation. The default implementation is a no-op that fails the request with a GCKErrorCodeUnsupportedFeature error.

Parameters
muted The new mute state.
Returns
A GCKRequest object for tracking the request.
Since
3.4; in previous framework versions, this method returned void.

Starts the session.

This is an asynchronous operation. Must be overridden by subclasses.

Provided by category GCKSession(Protected).

Ends the session with the specified action.

This is an asynchronous operation. Must be overridden by subclasses.

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

Provided by category GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Called by subclasses to notify the framework that the session has been started.

Parameters
sessionID The session's unique ID.

Provided by category GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (GCKError *)  error

Called by subclasses to notify the framework that the session has failed to start.

Parameters
error The error that occurred.

Provided by category GCKSession(Protected).

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

Called by subclasses to notify the framework that the session has ended.

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

Provided by category GCKSession(Protected).

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

Called by subclasses to notify the framework that updated device volume and mute state has been received from the device.

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

Provided by category GCKSession(Protected).

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

Called by subclasses to notify the framework that updated status has been received from the device.

Parameters
statusText The new status.

Provided by category GCKSession(Protected).

- (GCKActiveInputStatus) activeInputStatus readnonatomicassign

The device's current "active input" status.

- (GCKStandbyStatus) standbyStatus readnonatomicassign

The device's current "standby" status.

The metadata for the receiver application that is currently running on the receiver device, if any; otherwise nil.

readnonatomicstronginherited

The device that this session is associated with.

readnonatomiccopyinherited

The current session ID, if any.

- (GCKSessionOptions*) sessionOptions readnonatomicstronginherited

The session options, if any.

Since
4.0
- (GCKConnectionState) connectionState readnonatomicassigninherited

The current session connection state.

readnonatomicassigninherited

A flag indicating whether the session is currently suspended.

Deprecated:
GCKSession no longer supports being in suspended state. If needed, move this functionality to a subclass.
- (NSString*) deviceStatusText readnonatomiccopyinherited

The current device status text.

readnonatomiccopyinherited

The session traits.

- (float) currentDeviceVolume readnonatomicassigninherited

The current device volume, in the range [0.0, 1.0].

- (BOOL) currentDeviceMuted readnonatomicassigninherited

The current device mute state.

readnonatomicstronginherited readnonatomicstronginherited

The current media metadata, if any.

Will be nil if the session does not support the media namespace or if no media is currently loaded on the receiver.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-09-18 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["`GCKCastSession` manages a Cast session and its lifecycle, including channels, device status, and volume control, but applications should avoid directly managing the session's start and end."],["`GCKCastSession` provides properties for accessing session status, device information (like volume and mute state), and media control via `remoteMediaClient`."],["`GCKSession` is an abstract base class for Cast sessions, requiring subclasses to implement session start/end logic and provides properties for session status, device details, and media information."],["Subclasses of `GCKSession` use protected methods to notify the framework about session lifecycle events like start, end, errors, and device status changes."]]],["The `GCKCastSession` class manages Cast sessions, created by `GCKSessionManager`. Key actions include constructing sessions with options, registering/removing channels, and adding/removing device status listeners. It supports setting device volume and mute states, requesting multizone status, and controlling media playback. Subclasses use methods to notify the framework about session lifecycle events, device status, and connection status. It provides properties for session, device, and media status, with deprecated methods.\n"]]


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4