GCKMediaCommon.h File

  • This header file defines enums for media resume state and repeat mode, namely GCKMediaResumeState and GCKMediaRepeatMode.

  • It provides macros for GCKMediaResumeState, although they are now deprecated in favor of the enum directly.

  • A typedef GCKMediaControlChannelResumeState is also present, but it has been renamed to GCKMediaResumeState and is deprecated.

  • The file includes a function GCKIsValidTimeInterval to check if a time interval is valid and a constant kGCKInvalidTimeInterval to represent an invalid time interval.

  • The GCKMediaRepeatMode enum defines various playback repeat modes like GCKMediaRepeatModeOff, GCKMediaRepeatModeSingle, GCKMediaRepeatModeAll, and GCKMediaRepeatModeAllAndShuffle.
Macros | Typedefs | Enumerations | Functions | Variables
GCKMediaCommon.h File Reference

GCKMediaResumeState and GCKMediaRepeatMode enums. More...

Macros

#define GCKMediaControlChannelResumeStateUnchanged   GCKMediaResumeStateUnchanged
 Alias for GCKMediaResumeStateUnchanged. More...
 
#define GCKMediaControlChannelResumeStatePlay   GCKMediaResumeStatePlay
 Alias for GCKMediaResumeStatePlay. More...
 
#define GCKMediaControlChannelResumeStatePause   GCKMediaResumeStatePause
 Alias for GCKMediaResumeStatePause. More...
 

Typedefs

typedef GCKMediaResumeState GCKMediaControlChannelResumeState
 

Enumerations

enum  GCKMediaRepeatMode {
  GCKMediaRepeatModeUnchanged = 0, GCKMediaRepeatModeOff = 1, GCKMediaRepeatModeSingle = 2, GCKMediaRepeatModeAll = 3,
  GCKMediaRepeatModeAllAndShuffle = 4
}
 Enum defining the media control channel queue playback repeat modes. More...
 

Functions

typedef NS_CLOSED_ENUM (NSInteger, GCKMediaResumeState)
 
BOOL GCKIsValidTimeInterval (NSTimeInterval timeInterval)
 Tests if the given time interval value is kGCKInvalidTimeInterval. More...
 

Variables

const NSTimeInterval kGCKInvalidTimeInterval
 A constant indicating an invalid time interval. More...
 

Detailed Description

GCKMediaResumeState and GCKMediaRepeatMode enums.

Macro Definition Documentation

#define GCKMediaControlChannelResumeStateUnchanged   GCKMediaResumeStateUnchanged

Alias for GCKMediaResumeStateUnchanged.

Deprecated:
Use GCKMediaResumeStateUnchanged instead.
#define GCKMediaControlChannelResumeStatePlay   GCKMediaResumeStatePlay

Alias for GCKMediaResumeStatePlay.

Deprecated:
Use GCKMediaResumeStatePlay instead.
#define GCKMediaControlChannelResumeStatePause   GCKMediaResumeStatePause

Alias for GCKMediaResumeStatePause.

Deprecated:
Use GCKMediaResumeStatePause instead.

Typedef Documentation

typedef GCKMediaResumeState GCKMediaControlChannelResumeState
Deprecated:
Renamed to GCKMediaResumeState.

Enumeration Type Documentation

enum GCKMediaRepeatMode

Enum defining the media control channel queue playback repeat modes.

Enumerator
GCKMediaRepeatModeUnchanged 

A repeat mode indicating that the repeat mode should be left unchanged.

GCKMediaRepeatModeOff 

A repeat mode indicating no repeat.

GCKMediaRepeatModeSingle 

A repeat mode indicating that a single queue item should be played repeatedly.

GCKMediaRepeatModeAll 

A repeat mode indicating that the entire queue should be played repeatedly.

GCKMediaRepeatModeAllAndShuffle 

A repeat mode indicating that the entire queue should be played repeatedly.

The order of the items will be randomly shuffled once the last item in the queue finishes. The queue will continue to play starting from the first item of the shuffled items.

Function Documentation

BOOL GCKIsValidTimeInterval ( NSTimeInterval  timeInterval)

Tests if the given time interval value is kGCKInvalidTimeInterval.

Since
4.0

Variable Documentation

kGCKInvalidTimeInterval

A constant indicating an invalid time interval.

May be passed to methods which accept optional stream positions or time durations.