ShakaPlayer.h

Go to the documentation of this file.

// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SHAKA_EMBEDDED_SHAKA_PLAYER_H_
#define SHAKA_EMBEDDED_SHAKA_PLAYER_H_

#import <AVFoundation/AVFoundation.h>
#import <Foundation/Foundation.h>

#include "error_objc.h"
#include "macros.h"
#include "manifest_objc.h"
#include "net_objc.h"
#include "player_externs_objc.h"
#include "stats_objc.h"
#include "track_objc.h"

@class ShakaPlayer;

typedef void (^ShakaPlayerAsyncBlock)(ShakaPlayerError * _Nullable);

typedef NS_ENUM(NSInteger, ShakaPlayerLogLevel) {
  // These have the same values as shaka.log.Level.
  ShakaPlayerLogLevelNone = 0,
  ShakaPlayerLogLevelError = 1,
  ShakaPlayerLogLevelWarning = 2,
  ShakaPlayerLogLevelInfo = 3,
  ShakaPlayerLogLevelDebug = 4,
  ShakaPlayerLogLevelV1 = 5,
  ShakaPlayerLogLevelV2 = 6
};


NS_ASSUME_NONNULL_BEGIN

NSString *ShakaPlayerLicenseServerConfig(const NSString *key_system);

NSString *ShakaPlayerAdvancedDrmConfig(const NSString *key_system, const NSString *config);


SHAKA_EXPORT
@protocol ShakaPlayerClient <NSObject>

@optional

- (void)onPlayer:(ShakaPlayer *)player error:(ShakaPlayerError *)error;

- (void)onPlayer:(ShakaPlayer *)player bufferingChange:(BOOL)is_buffering;


- (void)onPlayerPlayingEvent:(ShakaPlayer *)player;

- (void)onPlayerPauseEvent:(ShakaPlayer *)player;

- (void)onPlayerEndedEvent:(ShakaPlayer *)player;


- (void)onPlayerSeekingEvent:(ShakaPlayer *)player;

- (void)onPlayerSeekedEvent:(ShakaPlayer *)player;

- (void)onPlayerAttachMse:(ShakaPlayer *)player;

- (void)onPlayerAttachSource:(ShakaPlayer *)player;

- (void)onPlayerDetach:(ShakaPlayer *)player;

@end


SHAKA_EXPORT
@protocol ShakaPlayerNetworkFilter <NSObject>

@optional

- (void)onPlayer:(ShakaPlayer *)player
  networkRequest:(ShakaPlayerRequest *)request
          ofType:(ShakaPlayerRequestType)type
       withBlock:(ShakaPlayerAsyncBlock)block;

- (void)onPlayer:(ShakaPlayer *)player
 networkResponse:(ShakaPlayerResponse*)response
          ofType:(ShakaPlayerRequestType)type
       withBlock:(ShakaPlayerAsyncBlock)block;

@end


SHAKA_EXPORT
@interface ShakaPlayerUiInfo : NSObject

@property(atomic) BOOL paused;

@property(atomic) BOOL ended;

@property(atomic) BOOL seeking;

@property(atomic) double duration;

@property(atomic) double playbackRate;

@property(atomic) double currentTime;

@property(atomic) double volume;

@property(atomic) BOOL muted;

@property(atomic) BOOL isAudioOnly;

@property(atomic) BOOL isLive;

@property(atomic) BOOL closedCaptions;

@property(atomic) ShakaBufferedRange *seekRange;

@property(atomic) ShakaBufferedInfo *bufferedInfo;

@end


SHAKA_EXPORT
@interface ShakaPlayer : NSObject

- (instancetype)init NS_UNAVAILABLE; // initWithError: should always be used

- (nullable instancetype)initWithError:(NSError * _Nullable __autoreleasing * _Nullable)error NS_SWIFT_NAME(init());


@property (atomic, weak, nullable) id<ShakaPlayerClient> client;

- (void)play;

- (void)pause;

@property(atomic, readonly) BOOL paused;

@property(atomic, readonly) BOOL ended;

@property(atomic, readonly) BOOL seeking;

@property(atomic, readonly) double duration;

@property(atomic) double playbackRate;

@property(atomic) double currentTime;

@property(atomic) double volume;

@property(atomic) BOOL muted;


@property(atomic) ShakaPlayerLogLevel logLevel;

@property(atomic, readonly, nullable) NSString *playerVersion;

@property(atomic, readonly) BOOL isAudioOnly;

@property(atomic, readonly) BOOL isLive;

@property(atomic) BOOL closedCaptions;

@property(atomic, readonly) NSArray<ShakaLanguageRole *> *audioLanguagesAndRoles;

@property(atomic, readonly) NSArray<ShakaLanguageRole *> *textLanguagesAndRoles;

@property(atomic, readonly, nullable) AVPlayer *avPlayer;


- (void)getUiInfoWithBlock:(void (^)(ShakaPlayerUiInfo *))block;

- (ShakaStats *)getStats;

- (NSArray<ShakaTrack *> *)getTextTracks;

- (NSArray<ShakaTrack *> *)getVariantTracks;

- (void)load:(NSString *)uri withBlock:(ShakaPlayerAsyncBlock)block;

- (void)load:(NSString *)uri
withStartTime:(double)startTime
     andBlock:(ShakaPlayerAsyncBlock)block;

- (void)unloadWithBlock:(ShakaPlayerAsyncBlock)block;


- (void)configure:(const NSString *)namePath withBool:(BOOL)value;

- (void)configure:(const NSString *)namePath withDouble:(double)value;

- (void)configure:(const NSString *)namePath withString:(const NSString *)value;

- (void)configure:(const NSString *)namePath withData:(NSData *)value;

- (void)configureWithDefault:(const NSString *)namePath;

- (BOOL)getConfigurationBool:(const NSString *)namePath;

- (double)getConfigurationDouble:(const NSString *)namePath;

- (nullable NSString *)getConfigurationString:(const NSString *)namePath;


- (void)selectAudioLanguage:(NSString *)language withRole:(nullable NSString *)role;

- (void)selectAudioLanguage:(NSString *)language;

- (void)selectTextLanguage:(NSString *)language withRole:(nullable NSString *)role;

- (void)selectTextLanguage:(NSString *)language;

- (void)selectTextTrack:(const ShakaTrack *)track;

- (void)selectVariantTrack:(const ShakaTrack *)track;

- (void)selectVariantTrack:(const ShakaTrack *)track withClearBuffer:(BOOL)clear;

- (void)destroy;



- (void)addTextTrack:(NSString *)uri
            language:(NSString *)lang
                kind:(NSString *)kind
                mime:(NSString *)mime;
- (void)addTextTrack:(NSString *)uri
            language:(NSString *)lang
                kind:(NSString *)kind
                mime:(NSString *)mime
               codec:(nullable NSString *)codec;
- (void)addTextTrack:(NSString *)uri
            language:(NSString *)lang
                kind:(NSString *)kind
                mime:(NSString *)mime
               codec:(nullable NSString *)codec
               label:(nullable NSString *)label;

- (void)addNetworkFilter:(id<ShakaPlayerNetworkFilter>)filter;

- (void)removeNetworkFilter:(id<ShakaPlayerNetworkFilter>)filter;

@end

NS_ASSUME_NONNULL_END
#endif  // SHAKA_EMBEDDED_SHAKA_PLAYER_H_