GoogleCastSessionManagerIOSMethodChannel class
iOS-specific implementation of Google Cast session manager functionality.
- Implemented types
Constructors
- GoogleCastSessionManagerIOSMethodChannel.new()
- Creates a new iOS session manager method channel.
Properties
- connectionState → GoogleCastConnectState
-
readnonatomicassign
The current session connection state.
no setteroverride
- currentCastSession → GoogleCastSession?
-
Returns the current cast session if available.
no setter
- currentSession → GoogleCastSession?
-
The current session, if any.
no setteroverride
-
currentSessionStream
→ Stream<
GoogleCastSession?> -
Stream of current session changes.
no setteroverride
- hasConnectedSession → bool
-
Tests if a session is currently being managed by this session manager, and it is currently connected.
This will be YES if the session state is ConnectionStateConnected.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
endSession(
) → Future< bool> -
Ends the current session.
This is an asynchronous operation.
Returns
YES if the operation has been started successfully, NO if there is no session currently established or if the operation could not be started.
override
-
endSessionAndStopCasting(
) → Future< bool> -
Ends the current session and stops casting if one sender device is connected; otherwise, optionally stops casting if multiple sender devices are connected.
Use the stopCasting parameter to indicate whether casting on the receiver should stop when the session ends. This parameter only applies when multiple sender devices are connected. For example, the same app is open on multiple sender devices and each sender device has an active Cast session with the same receiver device.
If you set stopCasting to YES, the receiver app stops casting when multiple devices are connected.
If stopCasting is NO and other devices have an active session, the receiver keeps playing.
If only one sender device is connected, the receiver app stops casting the media and ignores the stopCasting value, even if it's set to NO.
Parameters
stopCasting Whether casting on the receiver should stop when the session ends. Only used when multiple sender devices are connected.
Returns
YES if the operation to end the session started successfully, NO if there is no session currently established or if the operation could not be started.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setDefaultSessionOptions(
) → Future< void> -
Sets the default session options for devices in a specific category (iOS only).
override
-
setDeviceVolume(
double value) → void -
Sets the device volume.
override
-
startSessionWithDevice(
GoogleCastDevice device) → Future< bool> -
Starts a new session with the given device, using the default session options that were registered for the device category, if any.
This is an asynchronous operation.
Parameters
device The device to use for this session.
Returns
YES if the operation has been started successfully, NO if there is a session currently established or if the operation could not be started.
override
-
startSessionWithOpenURLOptions(
) → Future< bool> -
Attempts to join or start a session with options that were supplied to the UIApplicationDelegate::application:openURL:options: method.
Typically this is a request to join an existing Cast session on a particular device that was initiated by another app.
Parameters
openURLOptions The options that were extracted from the URL.
override
-
suspendSessionWithReason(
) → Future< bool> -
Suspends the current session.
This is an asynchronous operation.
Parameters
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited