Membrane RTSP v0.3.0

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

RTSP Session

Link to this section Summary

Types

headers()
t()

Functions

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

Returns a specification to start this module under a supervisor.

close(session)
describe(session, headers \\ [])
get_parameter(session, headers \\ [], body \\ "")
options(session, headers \\ [])
pause(session, headers \\ [])
play(session, headers \\ [])
record(session, headers \\ [])
request(session, method, headers \\ [], body \\ "", path \\ nil)
set_parameter(session, headers \\ [], body \\ "")
setup(session, path, headers \\ [])
start(url, transport \\ Membrane.RTSP.Transport.TCPSocket, options \\ [])
start_link(url, transport \\ Membrane.RTSP.Transport.TCPSocket, options \\ [])

Starts and links session process.

teardown(session, headers \\ [])

Link to this section Types

Link to this type

headers()

View Source

Specs

headers() :: [{binary(), binary()}]
Link to this type

t()

View Source

Specs

t() :: pid()

Link to this section Functions

Link to this function

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

View Source

Specs

announce(t(), headers(), binary()) :: Membrane.RTSP.Response.result()
Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

close(session)

View Source

Specs

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

describe(session, headers \\ [])

View Source

Specs

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

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

View Source

Specs

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

options(session, headers \\ [])

View Source

Specs

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

pause(session, headers \\ [])

View Source

Specs

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

play(session, headers \\ [])

View Source

Specs

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

record(session, headers \\ [])

View Source

Specs

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

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

View Source

Specs

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

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

View Source

Specs

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

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

View Source

Specs

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

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

View Source

Specs

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

Specs

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

Specs

teardown(t(), headers()) :: Membrane.RTSP.Response.result()