GCKSessionTraits Class Reference

An object describing the traits and capabilities of a session. More...

#import <GCKSessionTraits.h>

+ Inheritance diagram for GCKSessionTraits:

Instance Methods

(instancetype) - initWithMinimumVolume:maximumVolume:volumeIncrement:supportsMuting:
 Designated initializer. More...
 
(instancetype) - init
 Convenience initializer. More...
 
(BOOL) - isFixedVolume
 Whether this is a fixed volume device. More...
 

Properties

float minimumVolume
 The minimum volume value. More...
 
float maximumVolume
 The maximum volume value. More...
 
float volumeIncrement
 The volume increment for up/down volume adjustments. More...
 
BOOL supportsMuting
 Whether the audio can be muted. More...
 

Detailed Description

An object describing the traits and capabilities of a session.

Since
3.0

Method Documentation

- (instancetype) init

Convenience initializer.

Sets the volume range to [0.0, 1.0], the volume increment to 0.05 (5%), and the supportsMuting flag to YES.

- (instancetype) initWithMinimumVolume: (float)  minimumVolume
maximumVolume: (float)  maximumVolume
volumeIncrement: (float)  volumeIncrement
supportsMuting: (BOOL)  NS_DESIGNATED_INITIALIZER 

Designated initializer.

- (BOOL) isFixedVolume

Whether this is a fixed volume device.

Property Documentation

- (float) maximumVolume
readnonatomicassign

The maximum volume value.

Must be non-negative and greater than or equal to the minimum volume.

- (float) minimumVolume
readnonatomicassign

The minimum volume value.

Must be non-negative and less than or equal to the maximum volume.

- (BOOL) supportsMuting
readnonatomicassign

Whether the audio can be muted.

- (float) volumeIncrement
readnonatomicassign

The volume increment for up/down volume adjustments.

May be 0 to indicate fixed volume. Must be non-negative and less than or equal to the difference between the maximum volume and minimum volume.


The documentation for this class was generated from the following file: