blob: 5054c28676fa604c134775e130e4e5324e2f6945 [file] [log] [blame]
Donald E Curtisa8736442015-08-05 15:48:13 -07001/*
2 * Copyright 2014 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11#import <Foundation/Foundation.h>
tkchin9eeb6242016-04-27 01:54:20 -070012#import "WebRTC/RTCPeerConnection.h"
13#import "WebRTC/RTCVideoTrack.h"
Donald E Curtisa8736442015-08-05 15:48:13 -070014
15typedef NS_ENUM(NSInteger, ARDAppClientState) {
16 // Disconnected from servers.
17 kARDAppClientStateDisconnected,
18 // Connecting to servers.
19 kARDAppClientStateConnecting,
20 // Connected to servers.
21 kARDAppClientStateConnected,
22};
23
24@class ARDAppClient;
sakalc4adacf2017-03-28 01:22:48 -070025@class ARDSettingsModel;
denicijad17d5362016-11-02 02:56:09 -070026@class RTCMediaConstraints;
Daniela012b56b2017-11-15 13:15:24 +010027@class RTCCameraVideoCapturer;
28@class RTCFileVideoCapturer;
denicijad17d5362016-11-02 02:56:09 -070029
Donald E Curtisa8736442015-08-05 15:48:13 -070030// The delegate is informed of pertinent events and will be called on the
31// main queue.
32@protocol ARDAppClientDelegate <NSObject>
33
34- (void)appClient:(ARDAppClient *)client
35 didChangeState:(ARDAppClientState)state;
36
37- (void)appClient:(ARDAppClient *)client
hjon79858f82016-03-13 22:08:26 -070038 didChangeConnectionState:(RTCIceConnectionState)state;
Donald E Curtisa8736442015-08-05 15:48:13 -070039
40- (void)appClient:(ARDAppClient *)client
sakalc522e752017-04-05 12:17:48 -070041 didCreateLocalCapturer:(RTCCameraVideoCapturer *)localCapturer;
42
43- (void)appClient:(ARDAppClient *)client
Donald E Curtisa8736442015-08-05 15:48:13 -070044 didReceiveLocalVideoTrack:(RTCVideoTrack *)localVideoTrack;
45
46- (void)appClient:(ARDAppClient *)client
47 didReceiveRemoteVideoTrack:(RTCVideoTrack *)remoteVideoTrack;
48
49- (void)appClient:(ARDAppClient *)client
50 didError:(NSError *)error;
51
Zeke Chind3325802015-08-14 11:00:02 -070052- (void)appClient:(ARDAppClient *)client
53 didGetStats:(NSArray *)stats;
54
Daniela012b56b2017-11-15 13:15:24 +010055@optional
56- (void)appClient:(ARDAppClient *)client
57didCreateLocalFileCapturer:(RTCFileVideoCapturer *)fileCapturer;
58
Donald E Curtisa8736442015-08-05 15:48:13 -070059@end
60
61// Handles connections to the AppRTC server for a given room. Methods on this
62// class should only be called from the main queue.
63@interface ARDAppClient : NSObject
64
Zeke Chind3325802015-08-14 11:00:02 -070065// If |shouldGetStats| is true, stats will be reported in 1s intervals through
66// the delegate.
67@property(nonatomic, assign) BOOL shouldGetStats;
Donald E Curtisa8736442015-08-05 15:48:13 -070068@property(nonatomic, readonly) ARDAppClientState state;
69@property(nonatomic, weak) id<ARDAppClientDelegate> delegate;
Donald E Curtisa8736442015-08-05 15:48:13 -070070// Convenience constructor since all expected use cases will need a delegate
71// in order to receive remote tracks.
sakalc4adacf2017-03-28 01:22:48 -070072- (instancetype)initWithDelegate:(id<ARDAppClientDelegate>)delegate;
denicija8c375de2016-11-08 06:28:17 -080073
Donald E Curtisa8736442015-08-05 15:48:13 -070074// Establishes a connection with the AppRTC servers for the given room id.
sakalc4adacf2017-03-28 01:22:48 -070075// |settings| is an object containing settings such as video codec for the call.
haysc913e6452015-10-02 11:44:03 -070076// If |isLoopback| is true, the call will connect to itself.
Donald E Curtisa8736442015-08-05 15:48:13 -070077- (void)connectToRoomWithId:(NSString *)roomId
sakalc4adacf2017-03-28 01:22:48 -070078 settings:(ARDSettingsModel *)settings
Anders Carlssone1500582017-06-15 16:05:13 +020079 isLoopback:(BOOL)isLoopback;
Donald E Curtisa8736442015-08-05 15:48:13 -070080
81// Disconnects from the AppRTC servers and any connected clients.
82- (void)disconnect;
83
84@end