headers

Documentation

Overview

Package headers contains various RTSP headers.

Index

• Constants
• type AuthMethod
• type Authenticate
  • func (h Authenticate) Marshal() base.HeaderValue
  • func (h *Authenticate) Unmarshal(v base.HeaderValue) error
• type Authorization
  • func (h Authorization) Marshal() base.HeaderValue
  • func (h *Authorization) Unmarshal(v base.HeaderValue) error
• type RTPInfo
  • func (h RTPInfo) Marshal() base.HeaderValue
  • func (h *RTPInfo) Unmarshal(v base.HeaderValue) error
• type RTPInfoEntry
• type Range
  • func (h Range) Marshal() base.HeaderValue
  • func (h *Range) Unmarshal(v base.HeaderValue) error
• type RangeNPT
• type RangeSMPTE
• type RangeSMPTETime
• type RangeUTC
• type RangeValue
• type Session
  • func (h Session) Marshal() base.HeaderValue
  • func (h *Session) Unmarshal(v base.HeaderValue) error
• type Transport
  • func (h Transport) Marshal() base.HeaderValue
  • func (h *Transport) Unmarshal(v base.HeaderValue) error
• type TransportDelivery
• type TransportMode
• type TransportProtocol
• type Transports
  • func (ts Transports) Marshal() base.HeaderValue
  • func (ts *Transports) Unmarshal(v base.HeaderValue) error

Constants

const (
	// AuthDigest is an alias for AuthDigestMD5
	//
	// Deprecated: replaced by AuthDigestMD5
	AuthDigest = AuthDigestMD5
)

Types

type AuthMethod

type AuthMethod int

AuthMethod is an authentication method.

const (
	// AuthBasic is the Basic authentication method
	AuthBasic AuthMethod = iota

	// AuthDigestMD5 is the Digest authentication method with the MD5 hash
	AuthDigestMD5

	// AuthDigestSHA256 is the Digest authentication method with the SHA-256 hash
	AuthDigestSHA256
)

type Authenticate

type Authenticate struct {
	// authentication method
	Method AuthMethod

	// realm
	Realm string

	// nonce
	Nonce string

	// opaque
	Opaque *string

	// stale
	Stale *string
}

Authenticate is a WWW-Authenticate header.

func (Authenticate) Marshal

func (h Authenticate) Marshal() base.HeaderValue

Marshal encodes a WWW-Authenticate header.

func (*Authenticate) Unmarshal

func (h *Authenticate) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a WWW-Authenticate header.

type Authorization

type Authorization struct {
	// authentication method
	Method AuthMethod

	// user
	BasicUser string

	// password
	BasicPass string

	// username
	Username string

	// realm
	Realm string

	// nonce
	Nonce string

	// URI
	URI string

	// response
	Response string

	// opaque
	Opaque *string
}

Authorization is an Authorization header.

func (Authorization) Marshal

func (h Authorization) Marshal() base.HeaderValue

Marshal encodes an Authorization header.

func (*Authorization) Unmarshal

func (h *Authorization) Unmarshal(v base.HeaderValue) error

Unmarshal decodes an Authorization header.

type RTPInfo

type RTPInfo []*RTPInfoEntry

RTPInfo is a RTP-Info header.

func (RTPInfo) Marshal

func (h RTPInfo) Marshal() base.HeaderValue

Marshal encodes a RTP-Info header.

func (*RTPInfo) Unmarshal

func (h *RTPInfo) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a RTP-Info header.

type RTPInfoEntry

type RTPInfoEntry struct {
	URL            string
	SequenceNumber *uint16
	Timestamp      *uint32
}

RTPInfoEntry is an entry of a RTP-Info header.

type Range

type Range struct {
	// range expressed in a certain unit.
	Value RangeValue

	// time at which the operation is to be made effective.
	Time *time.Time
}

Range is a Range header.

func (Range) Marshal

func (h Range) Marshal() base.HeaderValue

Marshal encodes a Range header.

func (*Range) Unmarshal

func (h *Range) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a Range header.

type RangeNPT

type RangeNPT struct {
	Start time.Duration
	End   *time.Duration
}

RangeNPT is a range expressed in NPT units.

type RangeSMPTE

type RangeSMPTE struct {
	Start RangeSMPTETime
	End   *RangeSMPTETime
}

RangeSMPTE is a range expressed in SMPTE unit.

type RangeSMPTETime

type RangeSMPTETime struct {
	Time     time.Duration
	Frame    uint
	Subframe uint
}

RangeSMPTETime is a time expressed in SMPTE unit.

type RangeUTC

type RangeUTC struct {
	Start time.Time
	End   *time.Time
}

RangeUTC is a range expressed in UTC units.

type RangeValue

type RangeValue interface {
	// contains filtered or unexported methods
}

RangeValue can be - RangeSMPTE - RangeNPT - RangeUTC

type Session

type Session struct {
	// session id
	Session string

	// (optional) a timeout
	Timeout *uint
}

Session is a Session header.

func (Session) Marshal

func (h Session) Marshal() base.HeaderValue

Marshal encodes a Session header.

func (*Session) Unmarshal

func (h *Session) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a Session header.

type Transport

type Transport struct {
	// protocol of the stream
	Protocol TransportProtocol

	// (optional) delivery method of the stream
	Delivery *TransportDelivery

	// (optional) Source IP
	Source *net.IP

	// (optional) destination IP
	Destination *net.IP

	// (optional) interleaved frame ids
	InterleavedIDs *[2]int

	// (optional) TTL
	TTL *uint

	// (optional) ports
	Ports *[2]int

	// (optional) client ports
	ClientPorts *[2]int

	// (optional) server ports
	ServerPorts *[2]int

	// (optional) SSRC of the packets of the stream
	SSRC *uint32

	// (optional) mode
	Mode *TransportMode
}

Transport is a Transport header.

func (Transport) Marshal

func (h Transport) Marshal() base.HeaderValue

Marshal encodes a Transport header.

func (*Transport) Unmarshal

func (h *Transport) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a Transport header.

type TransportDelivery

type TransportDelivery int

TransportDelivery is a delivery method.

const (
	TransportDeliveryUnicast TransportDelivery = iota
	TransportDeliveryMulticast
)

transport delivery methods.

type TransportMode

type TransportMode int

TransportMode is a transport mode.

const (
	// TransportModePlay is the "play" transport mode
	TransportModePlay TransportMode = iota

	// TransportModeRecord is the "record" transport mode
	TransportModeRecord
)

type TransportProtocol

type TransportProtocol int

TransportProtocol is a transport protocol.

const (
	TransportProtocolUDP TransportProtocol = iota
	TransportProtocolTCP
)

transport protocols.

type Transports

type Transports []Transport

Transports is a Transport header with multiple transports.

func (Transports) Marshal

func (ts Transports) Marshal() base.HeaderValue

Marshal encodes a Transport header.

func (*Transports) Unmarshal

func (ts *Transports) Unmarshal(v base.HeaderValue) error

Unmarshal decodes a Transport header.