summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/sdk/objc/components/capturer/RTCFileVideoCapturer.h
blob: 19262c64cf38db462f1237c6b5d8f16e1579e6d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 *  Copyright 2017 The WebRTC Project Authors. All rights reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#import <Foundation/Foundation.h>

#import "RTCVideoCapturer.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * Error passing block.
 */
typedef void (^RTCFileVideoCapturerErrorBlock)(NSError *error);

/**
 * Captures buffers from bundled video file.
 *
 * See @c RTCVideoCapturer for more info on capturers.
 */
RTC_OBJC_EXPORT

NS_CLASS_AVAILABLE_IOS(10)
@interface RTC_OBJC_TYPE (RTCFileVideoCapturer) : RTC_OBJC_TYPE(RTCVideoCapturer)

/**
 * Starts asynchronous capture of frames from video file.
 *
 * Capturing is not started if error occurs. Underlying error will be
 * relayed in the errorBlock if one is provided.
 * Successfully captured video frames will be passed to the delegate.
 *
 * @param nameOfFile The name of the bundled video file to be read.
 * @errorBlock block to be executed upon error.
 */
- (void)startCapturingFromFileNamed:(NSString *)nameOfFile
                            onError:(__nullable RTCFileVideoCapturerErrorBlock)errorBlock;

/**
 * Immediately stops capture.
 */
- (void)stopCapture;
@end

NS_ASSUME_NONNULL_END