Specs

add_stream(pid :: pid(), n_components :: integer(), name :: String.t()) ::
  {:ok, integer()}
  | {:error,
     :failed_to_add_stream
     | :invalid_stream_or_duplicate_name
     | :failed_to_attach_recv}

Adds a new stream with n_components components. name is optional but not passing it will influence on SDP string format, see generate_local_sdp/1.

Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

forget_relays(pid :: pid(), stream_id :: integer(), component_id :: integer()) ::
  :ok | {:error, :component_not_found}

Forget all TURN servers for given component.

Specs

gather_candidates(pid :: pid(), stream_id :: integer()) ::
  :ok | {:error, :invalid_stream_or_allocation}

Starts gathering candidates process for stream with id stream_id.

May cause the parent process receive following messages:

• {:new_candidate_full, candidate} - new local candidate
• {:candidate_gathering_done, stream_id} - gathering candidates for stream with stream_id has been done

Specs

generate_local_sdp(pid :: pid()) :: {:ok, sdp :: String.t()}

Generates a SDP string containing the local candidates and credentials for all streams and components.

Notice that:

• local candidates will be present in the result SDP only if gather_candidates/1 has been invoked previously
• if a stream is created without a name the 'm' line will contain '-' mark but SDP in this form will not be parsable by parse_remote_sdp/2

Specs

get_local_credentials(pid :: pid(), stream_id :: integer()) ::
  {:ok, credentials :: String.t()} | {:error, :failed_to_get_credentials}

Returns local credentials for stream with id stream_id.

Specs

parse_remote_sdp(pid :: pid(), sdp :: String.t()) ::
  {:ok, added_cand_num :: integer()} | {:error, :failed_to_parse_sdp}

Parses a remote SDP string setting credentials and remote candidates for proper streams and components. It is important that m line does not contain - mark but the name of the stream.

Specs

peer_candidate_gathering_done(pid :: pid(), stream_id :: integer()) ::
  :ok | {:error, :stream_not_found}

Indicates that all remote candidates for stream with id stream_id have been passed.

After receiving this message components can change their state to FAILED if all their connectivity checks have failed. Not sending this message will cause components stay in CONNECTING state. (In fact there is a bug and components can change their state to FAILED even without sending this message. Please refer to #120

Specs

remove_stream(pid :: pid(), stream_id :: integer()) :: :ok

Removes stream with id stream_id.

Specs

restart(pid :: pid()) :: :ok | {:error, :failed_to_restart}

Restarts all streams.

Specs

restart_stream(pid :: pid(), stream_id :: integer()) ::
  :ok | {:error, :failed_to_restart}

Restarts stream with id stream_id.

Specs

send_payload(
  pid :: pid(),
  stream_id :: integer(),
  component_id :: integer(),
  payload :: binary()
) :: :ok | {:error, :failed_to_send}

Sends payload on component with id component_id in stream with id stream_id. Payload has to be in a binary format.

Specs

set_relay_info(
  pid :: pid(),
  stream_id :: integer(),
  component_id :: integer() | [integer()] | :all,
  relay_info :: relay_info() | [relay_info()]
) ::
  :ok
  | {:error,
     :bad_stream_id
     | :bad_relay_type
     | :failed_to_resolve_addr
     | :failed_to_set_turn}

Sets TURN server. Can be called multiple times for the same component to add many TURN servers.

Specs

set_remote_candidate(
  pid :: pid(),
  candidate :: String.t(),
  stream_id :: integer(),
  component_id :: integer()
) :: :ok | {:error, :failed_to_parse_sdp_string | :failed_to_set}

Sets remote candidate for component with id component_id in stream with id stream_id. Candidate has to be passed as SDP string.

May cause the parent process receive following messages:

• {:new_remote_candidate_full, candidate} - new remote (prflx) candidate
• {:new_selected_pair, stream_id, component_id, lfoundation, rfoundation} - new selected pair
• {:component_state_failed, stream_id, component_id} - component with id component_id in stream with id stream_id has changed state to FAILED
• {:component_state_ready, stream_id, component_id} - component with id component_id in stream with id stream_id has changed state to READY i.e. it is ready to receive and send data

Specs

set_remote_credentials(
  pid :: pid(),
  credentials :: String.t(),
  stream_id :: integer()
) :: :ok | {:error, :failed_to_set_credentials}

Sets remote credentials for stream with stream_id. Credentials have to be passed in form of ufrag pwd.

Specs

start_link(opts :: opts_t()) :: {:ok, pid()}

Spawns new process responsible for interacting with libnice.