ShakaPlayerStorage.h

Go to the documentation of this file.

// Copyright 2019 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_STORAGE_H_
#define SHAKA_EMBEDDED_SHAKA_PLAYER_STORAGE_H_

#import <Foundation/Foundation.h>

#include "macros.h"
#include "offline_externs_objc.h"
#include "ShakaPlayer.h"


NS_ASSUME_NONNULL_BEGIN

SHAKA_EXPORT
@protocol ShakaPlayerStorageClient <NSObject>

@optional

- (void)onStorageProgress:(double)progress
              withContent:(ShakaStoredContent *)content;

@end

SHAKA_EXPORT
@interface ShakaPlayerStorage : NSObject

- (nullable instancetype)initWithError:(NSError * _Nullable __autoreleasing * _Nullable)error NS_SWIFT_NAME(init());
- (nullable instancetype)initWithPlayer:(ShakaPlayer * _Nullable) player
                               andError:(NSError * _Nullable __autoreleasing * _Nullable)error NS_SWIFT_NAME(init(player:));

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

@property(atomic, readonly) BOOL storeInProgress;

- (void)destroyWithBlock:(ShakaPlayerAsyncBlock) block;

- (void)listWithBlock:(void (^)(NSArray<ShakaStoredContent *> *,
                                ShakaPlayerError * _Nullable)) block;

- (void)remove:(NSString *)content_uri withBlock:(ShakaPlayerAsyncBlock) block;

- (void)removeEmeSessionsWithBlock:(void (^)(BOOL, ShakaPlayerError * _Nullable)) block;

- (void) store:(NSString*)uri
     withBlock:(void (^)(ShakaStoredContent *, ShakaPlayerError * _Nullable)) block;

- (void)store:(NSString *)uri
    withAppMetadata:(NSDictionary<NSString *, NSString *> *)data
           andBlock:(void (^)(ShakaStoredContent *, ShakaPlayerError * _Nullable))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)configureWithDefault:(const NSString *)namePath;

@end

NS_ASSUME_NONNULL_END
#endif  // SHAKA_EMBEDDED_SHAKA_PLAYER_STORAGE_H_