711/Pods/NAKPlaybackIndicatorView/Classes/NAKPlaybackIndicatorView.h

//
//  NAKPlaybackIndicatorView.h
//  PlaybackIndicator
//
//  Created by Yuji Nakayama on 1/27/14.
//  Copyright (c) 2014 Yuji Nakayama. All rights reserved.
//

#import <UIKit/UIKit.h>
#import "NAKPlaybackIndicatorViewStyle.h"

/**
 Values for the [state]([NAKPlaybackIndicatorView state]) property.
 */
typedef NS_ENUM(NSInteger, NAKPlaybackIndicatorViewState) {
    /**
     Stopped state of an indicator view.
     In this state, if an indicator's [hidesWhenStopped]([NAKPlaybackIndicatorView hidesWhenStopped]) is `YES`, the indicator becomes hidden.
     Or if an indicator's [hidesWhenStopped]([NAKPlaybackIndicatorView hidesWhenStopped]) is `NO`, the indicator shows idle bars.
     */
    NAKPlaybackIndicatorViewStateStopped = 0,

    /**
     Playing state of an indicator view.
     In this state, an indicator shows oscillatory animated bars.
     */
    NAKPlaybackIndicatorViewStatePlaying,

    /**
     Paused state of an indicator view.
     In this state, an indicator shows idle bars.
     */
    NAKPlaybackIndicatorViewStatePaused
};

/**
 `NAKPlaybackIndicatorView` is a view that mimics the music playback indicator in the Music.app on iOS 7.

 It has some vertical bars which oscillate randomly.
 The color of the bars can be changed by setting `tintColor` property (`UIView`) of the receiver or its ancestor view.

 Out of the box it works well with Auto Layout system as it provides sensible layout information
 such as intrinsic content size, baseline, and priorities of content hugging / compression resistence.
 Of course, it can work with frame-based layout system also.
 */
@interface NAKPlaybackIndicatorView : UIView

- (instancetype)initWithStyle:(NAKPlaybackIndicatorViewStyle*)style;

- (instancetype)initWithFrame:(CGRect)frame style:(NAKPlaybackIndicatorViewStyle*)style NS_DESIGNATED_INITIALIZER;

/**
 The style of the receiver.
 */
@property (nonatomic, readonly) NAKPlaybackIndicatorViewStyle* style;

/**
 The current state of the receiver.

 You can control the receiver's appearance and behavior by setting this property.

 - `NAKPlaybackIndicatorViewStateStopped`:
   - If hidesWhenStopped is `YES`, the receiver becomes hidden.
   - If hidesWhenStopped is `NO`, the receiver shows idle bars (same as `NAKPlaybackIndicatorViewStatePaused`).
 - `NAKPlaybackIndicatorViewStatePlaying`: The receiver shows oscillatory animated bars.
 - `NAKPlaybackIndicatorViewStatePaused`: The receiver shows idle bars.

 The initial value is `NAKPlaybackIndicatorViewStateStopped`.
 */
@property (nonatomic, assign) NAKPlaybackIndicatorViewState state;

/**
 A boolean value that controls whether the receiver is hidden
 when the state is set to `NAKPlaybackIndicatorViewStateStopped`.

 If the value of this property is `YES` (the default),
 the receiver sets its `hidden` property (`UIView`) to `YES`
 when receiver’s state is `NAKPlaybackIndicatorViewStateStopped`.
 If the value is `NO`, the receiver is shown even when it's stopped.

 Note that by setting state `NAKPlaybackIndicatorViewStatePlaying` or `NAKPlaybackIndicatorViewStatePaused`
 the receiver will be shown automatically.
 */
@property (nonatomic, assign) BOOL hidesWhenStopped;

@end