View Source Membrane.RTSP (Membrane RTSP v0.3.2)

RTSP Session

Link to this section Summary

Link to this section Types

@type headers() :: [{binary(), binary()}]
@type t() :: pid()

Link to this section Functions

Link to this function

announce(session, headers \\ [], body \\ "")

View Source
@spec announce(t(), headers(), binary()) :: Membrane.RTSP.Response.result()

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec close(pid()) :: :ok
Link to this function

describe(session, headers \\ [])

View Source
@spec describe(t(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

get_parameter(session, headers \\ [], body \\ "")

View Source
@spec get_parameter(t(), headers(), binary()) :: Membrane.RTSP.Response.result()
Link to this function

options(session, headers \\ [])

View Source
@spec options(t(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

pause(session, headers \\ [])

View Source
@spec pause(t(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

play(session, headers \\ [])

View Source
@spec play(t(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

record(session, headers \\ [])

View Source
@spec record(t(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

request(session, method, headers \\ [], body \\ "", path \\ nil)

View Source
@spec request(pid(), binary(), headers(), binary(), nil | binary()) ::
  Membrane.RTSP.Response.result()
Link to this function

set_parameter(session, headers \\ [], body \\ "")

View Source
@spec set_parameter(t(), headers(), binary()) :: Membrane.RTSP.Response.result()
Link to this function

setup(session, path, headers \\ [])

View Source
@spec setup(t(), binary(), headers()) :: Membrane.RTSP.Response.result()
Link to this function

start(url, transport \\ Membrane.RTSP.Transport.TCPSocket, options \\ [])

View Source
@spec start(binary(), module() | URI.t(), Keyword.t()) :: GenServer.on_start()
Link to this function

start_link(url, transport \\ Membrane.RTSP.Transport.TCPSocket, options \\ [])

View Source
@spec start_link(binary(), module() | URI.t(), Keyword.t()) :: GenServer.on_start()

Starts and links session process.

Sets following properties of Session:

  • transport - information for executing request over the network. For reference see Membrane.RTSP.Transport
  • url - a base path for requests
  • options - a keyword list that shall be passed when executing request over transport
Link to this function

teardown(session, headers \\ [])

View Source
@spec teardown(t(), headers()) :: Membrane.RTSP.Response.result()