TVIIceServer Class Reference

Inherits from NSObject
Declared in TVIIceOptions.h

Overview

TVIIceServer is a single STUN or TURN server.

  urlString

The URL string for the ICE server.

@property (nonnull, nonatomic, readonly, copy) NSString *urlString

Discussion

Your server URL must begin with either the stun: or turn: scheme. For example, a STUN server could be defined as <stun:stun.company.com:port>.

Declared In

TVIIceOptions.h

  username

The user name. Required for TURN servers.

@property (nullable, nonatomic, readonly, copy) NSString *username

Declared In

TVIIceOptions.h

  password

The password. Required for TURN servers.

@property (nullable, nonatomic, readonly, copy) NSString *password

Declared In

TVIIceOptions.h

– initWithURLString:

Creates a TVIIceServer.

- (null_unspecified instancetype)initWithURLString:(nonnull NSString *)serverURLString

Parameters

serverURLString

The URL for your STUN or TURN server.

Return Value

A TVIIceServer object.

Discussion

Creates a TVIIceServer.

Declared In

TVIIceOptions.h

– initWithURLString:username:password:

Creates a TVIIceServer.

- (null_unspecified instancetype)initWithURLString:(nonnull NSString *)serverURLString username:(nullable NSString *)username password:(nullable NSString *)password

Parameters

serverURLString

The URL for your STUN or TURN server.

username

The username credential for your server.

password

The password credential for your server.

Return Value

A TVIIceServer object.

Discussion

Creates a TVIIceServer.

Declared In

TVIIceOptions.h

– init

Developers should initialize with a parameterized initializer.

- (null_unspecified instancetype)init

Discussion

TVIIceServer cannot be created without supplying parameters.

Declared In

TVIIceOptions.h