// Copyright 2015 Google Inc.

#import <GoogleCast/GCKDefines.h>

#import <Foundation/Foundation.h>

/**
 * @file GCKMediaCommon.h
 * GCKMediaResumeState and GCKMediaRepeatMode enums.
 */

/**
 * @enum GCKMediaResumeState
 * Enum defining the media control channel resume state.
 */
typedef NS_ENUM(NSInteger, GCKMediaResumeState) {
  /** A resume state indicating that the player state should be left unchanged. */
  GCKMediaResumeStateUnchanged = 0,

  /**
   * A resume state indicating that the player should be playing, regardless of its current
   * state.
   */
  GCKMediaResumeStatePlay = 1,

  /**
   * A resume state indicating that the player should be paused, regardless of its current
   * state.
   */
  GCKMediaResumeStatePause = 2,
};

/**
 * @deprecated Renamed to GCKMediaResumeState.
 */
typedef GCKMediaResumeState GCKMediaControlChannelResumeState
    GCK_DEPRECATED("Use equivalent enum GCKMediaResumeState");

/**
 * Alias for GCKMediaResumeStateUnchanged
 * @deprecated Use GCKMediaResumeStateUnchanged instead.
 */
#define GCKMediaControlChannelResumeStateUnchanged GCKMediaResumeStateUnchanged

/**
 * Alias for GCKMediaResumeStatePlay
 * @deprecated Use GCKMediaResumeStatePlay instead.
 */
#define GCKMediaControlChannelResumeStatePlay GCKMediaResumeStatePlay

/**
 * Alias for GCKMediaResumeStatePause
 * @deprecated Use GCKMediaResumeStatePause instead.
 */
#define GCKMediaControlChannelResumeStatePause GCKMediaResumeStatePause

/**
 * @enum GCKMediaRepeatMode
 * Enum defining the media control channel queue playback repeat modes.
 */
typedef NS_ENUM(NSInteger, GCKMediaRepeatMode) {
  /** A repeat mode indicating that the repeat mode should be left unchanged. */
  GCKMediaRepeatModeUnchanged = 0,

  /** A repeat mode indicating no repeat. */
  GCKMediaRepeatModeOff = 1,

  /** A repeat mode indicating that a single queue item should be played repeatedly. */
  GCKMediaRepeatModeSingle = 2,

  /** A repeat mode indicating that the entire queue should be played repeatedly. */
  GCKMediaRepeatModeAll = 3,

  /**
   * 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.
   */
  GCKMediaRepeatModeAllAndShuffle = 4,
};

/**
 * @var kGCKInvalidTimeInterval
 * A constant indicating an invalid time interval. May be passed to methods which accept optional
 * stream positions or time durations.
 */
GCK_EXTERN const NSTimeInterval kGCKInvalidTimeInterval;

/**
 * Tests if the given time interval value is kGCKInvalidTimeInterval.
 *
 * @since 4.0
 */
GCK_EXTERN BOOL GCKIsValidTimeInterval(NSTimeInterval timeInterval);