client.h File Reference

import <Foundation/Foundation.h>
import <MillicastSDK/exports.h>

Include dependency graph for client.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	MCBitrateSettings
	The BitrateSettings class allows customizing bitrate settings for publishing streams. More...
class	MCHTTPConnectionError
class	MCSignalingError
class	MCCleanup
	The Cleanup class is responsible for cleaning the memory of dynamic objects. More...

Functions
typedef	NS_CLOSED_ENUM (NSInteger, MCDegradationPreferences)
	The DegradationPreferences enum. Based on the WebRTC standard
typedef	NS_CLOSED_ENUM (NSInteger, MCConnectionState)

Variables
void	connectWithWebsocketUrl
void	isConnectedWithCompletionHandler
void	disconnectWithCompletionHandler
void	enableStats
void	destroy

Function Documentation

NS_CLOSED_ENUM() [1/2]

typedef NS_CLOSED_ENUM	(	NSInteger	,
		MCConnectionState	)

The initial state of the socket. This state will be entered after graceful close.

The socket is in the process of connecting.

The socket has now established a connection.

The socket has entered reconnection state.

The socket is now in disconnecting state.

The socket has entered a failed state.

NS_CLOSED_ENUM() [2/2]

typedef NS_CLOSED_ENUM	(	NSInteger	,
		MCDegradationPreferences	)

The DegradationPreferences enum. Based on the WebRTC standard

Does not take any actions based on over-utilization signals.

On over-use, requests lower frame rate, possibly causing frame drops.

On over-use, requests lower resolution, possibly causing down-scaling.

Tries to strike a pleasing balance between frame rate or resolution.

No degradation preference, lets the SDK decide how to handle over-utilization.

Variable Documentation

connectWithWebsocketUrl

void connectWithWebsocketUrl

destroy

void destroy

Destroy the current client instance. This will invalidate the instance. Make sure to call at the end and do not use the subscriber/publisher instance after that.

disconnectWithCompletionHandler

void disconnectWithCompletionHandler

Disconnects from the Millicast platform.
Any ongoing process of publishing or subscribing content is automatically stopped before termination. The websocket connection to Millicast will no longer be active after disconnect is complete.

• Parameters:
  • completionHandler: Handler invoked when the result is ready.

enableStats

void enableStats

Enables or disables the collection and reporting of real-time statistics associated with streaming sessions. The statistics are collected once the client is either publishing or subscribed.

• Parameters:
  • enable: A boolean that determines whether the RTC reporting should be enabled (true) or disabled (false).
  • completionHandler: Handler invoked when the result is ready.

isConnectedWithCompletionHandler

void isConnectedWithCompletionHandler

Checks whether the client is connected to the media server.

• Parameters:
  • completionHandler: Handler invoked when the result is ready.