client.h

Go to the documentation of this file.

#import <Foundation/Foundation.h>
#import <MillicastSDK/exports.h>
 
// Forward declaration
@class MCStatsReport;
@protocol MCClient;
 
typedef NS_CLOSED_ENUM(NSInteger, MCDegradationPreferences)
{
  MCDegradationPreferencesDisabled,
 
  MCDegradationPreferencesMaintainResolution,
 
  MCDegradationPreferencesMaintainFrameRate,
 
  MCDegradationPreferencesBalanced,
 
  MCDegradationPreferencesDefault
};
 
typedef NS_CLOSED_ENUM(NSInteger, MCConnectionState)
{
  MCConnectionStateIdle,
  MCConnectionStateConnecting,
  MCConnectionStateConnected,
  MCConnectionStateReconnecting,
  MCConnectionStateDisconnecting,
  MCConnectionStateFailed
};
 
MILLICAST_API @interface MCBitrateSettings : NSObject
 
@property(nonatomic) BOOL      disableBWE;
 
@property(nonatomic) NSInteger maxBitrateKbps;
 
@property(nonatomic) NSInteger minBitrateKbps;
 
@property(nonatomic) NSInteger startBitrateKbps;
@end
 
MILLICAST_API @interface MCHTTPConnectionError: NSObject {
  NSNumber *code;
  NSString *reason;
}
@property (copy) NSNumber* _Nonnull code;
@property (copy) NSString* _Nonnull reason;
@end
 
MILLICAST_API @interface MCSignalingError: NSObject {
  NSString *reason;
}
@property (copy) NSString* _Nonnull reason;
@end
 
 
@protocol MCDelegate <NSObject>
 
- (void) client:(nonnull id<MCClient>) client didReceiveHTTPConnectionError:(nonnull MCHTTPConnectionError*) error
    NS_SWIFT_NAME(client(_:didReceiveHTTPConnectionError:));
 
- (void) client:(nonnull id<MCClient>) client didReceiveSignalingError:(nonnull MCSignalingError*) error
    NS_SWIFT_NAME(client(_:didReceiveSignalingError:));
 
@optional
- (void)client:(nonnull id<MCClient>) client didReceiveStatsReport:(nonnull MCStatsReport *) report
    NS_SWIFT_NAME(client(_:didReceiveStatsReport:));
 
@optional
- (void)client:(nonnull id<MCClient>) client didReceiveViewerCount:(int)viewerCount
    NS_SWIFT_NAME(client(_:didReceiveViewerCount:));
 
- (void)client:(nonnull id<MCClient>) client didReceiveWebsocketConnectionState:(MCConnectionState) state
    NS_SWIFT_NAME(client(_:didReceiveWebsocketConnectionState:));
 
- (void)client:(nonnull id<MCClient>) client didReceiveRTCPeerConnectionState:(MCConnectionState) state
    NS_SWIFT_NAME(client(_:didReceiveRTCPeerConnectionState:));
 
@end
 
typedef NS_CLOSED_ENUM(NSInteger, MCScalabilityMode)
{
    MCScalabilityModeNone,
    MCScalabilityModeL1T2 NS_SWIFT_NAME(l1t2),
    MCScalabilityModeL1T2h NS_SWIFT_NAME(l1t2h),
    MCScalabilityModeL1T3 NS_SWIFT_NAME(l1t3),
    MCScalabilityModeL1T3h NS_SWIFT_NAME(l1t3h),
    MCScalabilityModeL2T1 NS_SWIFT_NAME(l2t1),
    MCScalabilityModeL2T1h NS_SWIFT_NAME(l2t1h),
    MCScalabilityModeL2T1Key NS_SWIFT_NAME(l2t1Key),
    MCScalabilityModeL2T2 NS_SWIFT_NAME(l2t2),
    MCScalabilityModeL2T3 NS_SWIFT_NAME(l2t3),
    MCScalabilityModeL2T2h NS_SWIFT_NAME(l2t2h),
    MCScalabilityModeL2T2Key NS_SWIFT_NAME(l2t2Key),
    MCScalabilityModeL2T2KeyShift NS_SWIFT_NAME(l2t2KeyShift),
    MCScalabilityModeL2T3h NS_SWIFT_NAME(l2t3h),
    MCScalabilityModeL3T1 NS_SWIFT_NAME(l3t1),
    MCScalabilityModeL3T2 NS_SWIFT_NAME(l3t2),
    MCScalabilityModeL3T3 NS_SWIFT_NAME(l3t3),
    MCScalabilityModeL3T3Key NS_SWIFT_NAME(l3t3Key),
    MCScalabilityModeS2T1 NS_SWIFT_NAME(s2t1),
    MCScalabilityModeS2T2 NS_SWIFT_NAME(s2t2),
    MCScalabilityModeS2T3 NS_SWIFT_NAME(s2t3),
    MCScalabilityModeS3T1 NS_SWIFT_NAME(s3t1),
    MCScalabilityModeS3T2 NS_SWIFT_NAME(s3t2),
    MCScalabilityModeS3T3 NS_SWIFT_NAME(s3t3),
    MCScalabilityModeS2T1h NS_SWIFT_NAME(s2t1h),
    MCScalabilityModeS2T2h NS_SWIFT_NAME(s2t2h),
    MCScalabilityModeS2T3h NS_SWIFT_NAME(s2t3h),
    MCScalabilityModeS3T1h NS_SWIFT_NAME(s3t1h),
    MCScalabilityModeS3T2h NS_SWIFT_NAME(s3t2h),
    MCScalabilityModeS3T3h NS_SWIFT_NAME(s3t3h)
};
 
MILLICAST_API @interface MCConnectionOptions: NSObject
 
@property(nonatomic, assign) BOOL autoReconnect;
 
@end
 
MILLICAST_API @interface MCForcePlayoutDelay: NSObject 
- (nonnull instancetype) initWithMin: (int) min max: (int) max
  NS_SWIFT_NAME(init(min:max:));
 
@property(nonatomic, assign) int minimum;
 
@property(nonatomic, assign) int maximum;
 
@end
 
MILLICAST_API @interface MCClientOptions : NSObject
 
@property(nonatomic, retain, nullable) NSString *sourceId;
 
@property(nonatomic, retain, nullable) NSString *pinnedSourceId;
 
@property(nonatomic, retain, nullable) NSArray *excludedSourceId;
 
@property(nonatomic, assign) BOOL dtx;
 
@property(nonatomic, assign) int multiplexedAudioTrack;
 
 
@property(nonatomic, retain, nullable) NSString *videoCodec;
 
@property(nonatomic, retain, nullable) NSString *audioCodec;
 
 
@property(nonatomic, assign) MCDegradationPreferences degradationPreferences;
 
@property(nonatomic, retain, nullable) MCBitrateSettings *bitrateSettings;
 
@property(nonatomic, assign) BOOL stereo;
 
@property(nonatomic, assign) int statsDelayMs;
 
@property(nonatomic, assign) int jitterMinimumDelayMs;
 
@property(nonatomic, retain, nullable) MCForcePlayoutDelay *forcePlayoutDelay;
 
@property(nonatomic, assign) BOOL disableAudio;
 
@property(nonatomic, retain, nullable) NSNumber* maximumBitrate;
 
@property(nonatomic, assign) MCScalabilityMode svcMode;
 
 
@property(nonatomic, assign) BOOL simulcast;
 
@property(nonatomic, retain, nullable) NSString *rtcEventLogOutputPath;
 
 
@property(nonatomic,assign) BOOL recordStream;
 
@property(nonatomic, assign, nullable) NSNumber *priority;
 
@property(nonatomic, assign) BOOL forceSmooth;
 
@property(nonatomic, retain, nullable) NSNumber *bweMonitorDurationUs;
 
@property(nonatomic, retain, nullable) NSNumber *bweRateChangePercentage;
 
@property(nonatomic, retain, nullable) NSNumber *upwardsLayerWaitTimeMs;
 
@end
 
MILLICAST_API @protocol MCClient
 
- (void)connectWithCompletionHandler:(nonnull void (^)(NSError * _Nullable)) completionHandler;
 
 
- (void)connectWithOptions:(nonnull MCConnectionOptions *) options
         completionHandler:(nonnull void (^)(NSError * _Nullable)) completionHandler;
 
- (void)connectWithWebsocketUrl:(nonnull NSString *)websocketUrl jwt:(nonnull NSString *)jwt
              completionHandler:(nonnull void (^)(NSError * _Nullable)) completionHandler;
 
- (void)connectWithWebsocketUrl:(nonnull NSString *)websocketUrl jwt:(nonnull NSString *)jwt
              connectionOptions:(nonnull MCConnectionOptions *) connectionOptions
              completionHandler:(nonnull void (^)(NSError * _Nullable)) completionHandler;
 
- (void)isConnectedWithCompletionHandler:(nonnull void (^)(BOOL connected)) completionHandler;
 
 
- (void)disconnectWithCompletionHandler:(nonnull void (^)(NSError * _Nullable)) completionHandler;
 
- (void)enableStats:(BOOL)enable
  completionHandler:(nonnull void (^)(void)) completionHandler;
 
- (void) destroy;
 
@end
 
 
MILLICAST_API @interface MCCleanup : NSObject
 
+ (void)cleanup;
 
@end