description

Documentation

Overview

Package description contains objects to describe streams.

Index

• type Media
  • func (m Media) FindFormat(forma interface{}) bool
  • func (m Media) Marshal() *psdp.MediaDescription
  • func (m Media) URL(contentBase *base.URL) (*base.URL, error)
  • func (m *Media) Unmarshal(md *psdp.MediaDescription) error
• type MediaType
• type Session
  • func (d *Session) FindFormat(forma interface{}) *Media
  • func (d Session) Marshal(multicast bool) ([]byte, error)
  • func (d *Session) Unmarshal(ssd *sdp.SessionDescription) error
• type SessionFECGroup

Types

type Media

type Media struct {
	// Media type.
	Type MediaType

	// Media ID (optional).
	ID string

	// Whether this media is a back channel.
	IsBackChannel bool

	// Control attribute.
	Control string

	// Formats contained into the media.
	Formats []format.Format
}

Media is a media stream. It contains one or more formats.

func (Media) FindFormat

func (m Media) FindFormat(forma interface{}) bool

FindFormat finds a certain format among all the formats in the media.

func (Media) Marshal

func (m Media) Marshal() *psdp.MediaDescription

Marshal encodes the media in SDP format.

func (Media) URL

func (m Media) URL(contentBase *base.URL) (*base.URL, error)

URL returns the absolute URL of the media.

func (*Media) Unmarshal

func (m *Media) Unmarshal(md *psdp.MediaDescription) error

Unmarshal decodes the media from the SDP format.

type MediaType

type MediaType string

MediaType is the type of a media stream.

const (
	MediaTypeVideo       MediaType = "video"
	MediaTypeAudio       MediaType = "audio"
	MediaTypeApplication MediaType = "application"
)

media types.

type Session

type Session struct {
	// Base URL of the stream (read only).
	BaseURL *base.URL

	// Title of the stream (optional).
	Title string

	// FEC groups (RFC5109).
	FECGroups []SessionFECGroup

	// Media streams.
	Medias []*Media
}

Session is the description of a RTSP stream.

func (*Session) FindFormat

func (d *Session) FindFormat(forma interface{}) *Media

FindFormat finds a certain format among all the formats in all the medias of the stream. If the format is found, it is inserted into forma, and its media is returned.

func (Session) Marshal

func (d Session) Marshal(multicast bool) ([]byte, error)

Marshal encodes the description in SDP.

func (*Session) Unmarshal

func (d *Session) Unmarshal(ssd *sdp.SessionDescription) error

Unmarshal decodes the description from SDP.

type SessionFECGroup

type SessionFECGroup []string

SessionFECGroup is a FEC group.