blob: f78746c2fe86ce87c68f710a62c37de18b9f758f [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
2 * libjingle
3 * Copyright 2013, Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#import <Foundation/Foundation.h>
tkchin@webrtc.org1732a592014-05-19 23:26:01 +000029#if TARGET_OS_IPHONE
30#import <UIKit/UIKit.h>
31#endif
henrike@webrtc.org28e20752013-07-10 00:45:36 +000032
tkchin@webrtc.org1732a592014-05-19 23:26:01 +000033@class RTCI420Frame;
34@class RTCVideoRenderer;
35
36// RTCVideoRendererDelegate is a protocol for an object that must be
37// implemented to get messages when rendering.
38@protocol RTCVideoRendererDelegate<NSObject>
39
40// The size of the frame.
41- (void)renderer:(RTCVideoRenderer*)renderer didSetSize:(CGSize)size;
42
43// The frame to be displayed.
44- (void)renderer:(RTCVideoRenderer*)renderer
45 didReceiveFrame:(RTCI420Frame*)frame;
46
47@end
henrike@webrtc.org28e20752013-07-10 00:45:36 +000048
49// Interface for rendering VideoFrames from a VideoTrack
50@interface RTCVideoRenderer : NSObject
51
tkchin@webrtc.org1732a592014-05-19 23:26:01 +000052@property(nonatomic, weak) id<RTCVideoRendererDelegate> delegate;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000053
54// Initialize the renderer. Requires a delegate which does the actual drawing
55// of frames.
tkchin@webrtc.org1732a592014-05-19 23:26:01 +000056- (instancetype)initWithDelegate:(id<RTCVideoRendererDelegate>)delegate;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000057
tkchin@webrtc.org1732a592014-05-19 23:26:01 +000058#if TARGET_OS_IPHONE
59// DEPRECATED. See https://code.google.com/p/webrtc/issues/detail?id=3341 for
60// details.
61- (instancetype)initWithView:(UIView*)view;
62#endif
henrike@webrtc.orgd3d6bce2014-03-10 20:41:22 +000063
henrike@webrtc.org28e20752013-07-10 00:45:36 +000064#ifndef DOXYGEN_SHOULD_SKIP_THIS
65// Disallow init and don't add to documentation
fischman@webrtc.org7fa1fcb2014-03-25 00:11:56 +000066- (id)init __attribute__((
67 unavailable("init is not a supported initializer for this class.")));
henrike@webrtc.org28e20752013-07-10 00:45:36 +000068#endif /* DOXYGEN_SHOULD_SKIP_THIS */
69
70@end