webrtc_rtp_pause (webrtc v0.1.0)

View Source

RTP stream pause and resume (RFC 7728), without I/O.

Two sides, one state per RTP stream:

  • the stream sender (sender/1): honours PAUSE and RESUME carrying the current PauseID, answers others with REFUSED, sends PAUSED when it pauses and in the next two regular reports (§6.2), and moves to the next PauseID when it resumes (§8.1);
  • the requester (requester/0): sends PAUSE or RESUME for a stream it receives, retransmits it after 2 * RTT + T_dither_max until the sender answers (§6.1, §6.4), and learns the current PauseID from PAUSED and REFUSED.

Messages are {Type, PauseId} or {paused, PauseId, ExtSeq}; the caller puts them in RTPFB PAUSE-RESUME packets (#rtcp_pause{}) for the stream's SSRC.

Summary

Functions

What the sender last reported.

Ask the sender to pause or resume. Now and the RTT in ms (undefined when unknown) set the retransmission time.

PAUSED or REFUSED from the sender.

An RTP packet of the stream arrived: a paused stream resumed, and the sender moved to the next PauseID (§8.1).

Retransmit an unanswered request.

A sender, paused from the start when the answer marked the stream paused (RFC 8853 §5.3).

A PAUSE or RESUME from the requester. HoldOff is 0 when nowait was negotiated, 2 * RTT + T_dither_max otherwise (§6.2); Seq is the extended sequence number of the last packet sent.

Messages to add to a regular report.

The hold-off is over: pause.

Types

event/0

-type event() :: none | paused | resumed | refused.

message/0

-type message() :: {pause | resume | refused, 0..65535} | {paused, 0..65535, non_neg_integer()}.

requester/0

-opaque requester()

sender/0

-opaque sender()

Functions

is_paused(Snd)

-spec is_paused(sender()) -> boolean().

remote_state(Req)

-spec remote_state(requester()) -> playing | paused.

What the sender last reported.

request(Want, _, Req)

-spec request(pause | resume, {integer(), undefined | non_neg_integer()}, requester()) ->
                 {requester(), [message()]}.

Ask the sender to pause or resume. Now and the RTT in ms (undefined when unknown) set the retransmission time.

requester()

-spec requester() -> requester().

requester_in(_, Now, Req)

-spec requester_in(message(), integer(), requester()) -> {requester(), event()}.

PAUSED or REFUSED from the sender.

requester_next_timeout(Req)

-spec requester_next_timeout(requester()) -> integer() | infinity.

requester_rtp(Req)

-spec requester_rtp(requester()) -> {requester(), event()}.

An RTP packet of the stream arrived: a paused stream resumed, and the sender moved to the next PauseID (§8.1).

requester_timeout(Now, Rtt, Req)

-spec requester_timeout(integer(), undefined | non_neg_integer(), requester()) ->
                           {requester(), [message()]}.

Retransmit an unanswered request.

sender(_)

-spec sender(boolean()) -> sender().

A sender, paused from the start when the answer marked the stream paused (RFC 8853 §5.3).

sender_in(Type, Id, Seq, T, Snd)

-spec sender_in(pause | resume, 0..65535, non_neg_integer(), {integer(), non_neg_integer()}, sender()) ->
                   {sender(), [message()], event()}.

A PAUSE or RESUME from the requester. HoldOff is 0 when nowait was negotiated, 2 * RTT + T_dither_max otherwise (§6.2); Seq is the extended sequence number of the last packet sent.

sender_next_timeout(Snd)

-spec sender_next_timeout(sender()) -> integer() | infinity.

sender_report(Seq, Snd)

-spec sender_report(non_neg_integer(), sender()) -> {sender(), [message()]}.

Messages to add to a regular report.

sender_timeout(_, Snd)

-spec sender_timeout({integer(), non_neg_integer()}, sender()) -> {sender(), [message()], event()}.

The hold-off is over: pause.