client

Documentation

Index

• type AnnounceReq
• type AnnounceRes
• type Client
• type DescribeReq
• type DescribeRes
• type ErrAuthCritical
  • func (ErrAuthCritical) Error() string
• type ErrAuthNotCritical
  • func (ErrAuthNotCritical) Error() string
• type ErrNoOnePublishing
  • func (e ErrNoOnePublishing) Error() string
• type Path
• type PauseReq
• type PlayReq
• type PlayRes
• type RecordReq
• type RemoveReq
• type SetupPlayReq
• type SetupPlayRes
• type StartingPointReq
• type TrackStartingPoint

Types

type AnnounceReq

type AnnounceReq struct {
	Client   Client
	PathName string
	Tracks   gortsplib.Tracks
	Data     interface{}
	Res      chan AnnounceRes
}

AnnounceReq is a client announce request.

type AnnounceRes

type AnnounceRes struct {
	Path Path
	Err  error
}

AnnounceRes is a client announce response.

type Client

type Client interface {
	IsClient()
	IsSource()
	Close()
	Authenticate([]headers.AuthMethod,
		string, []interface{},
		string, string, interface{}) error
	OnIncomingFrame(int, gortsplib.StreamType, []byte)
}

Client is implemented by all client*.

type DescribeReq

type DescribeReq struct {
	Client   Client
	PathName string
	Data     *base.Request
	Res      chan DescribeRes
}

DescribeReq is a client describe request.

type DescribeRes

type DescribeRes struct {
	SDP      []byte
	Redirect string
	Err      error
}

DescribeRes is a client describe response.

type ErrAuthCritical

type ErrAuthCritical struct {
	*base.Response
}

ErrAuthCritical is a critical authentication error.

func (ErrAuthCritical) Error

func (ErrAuthCritical) Error() string

Error implements the error interface.

type ErrAuthNotCritical

type ErrAuthNotCritical struct {
	*base.Response
}

ErrAuthNotCritical is a non-critical authentication error.

func (ErrAuthNotCritical) Error

func (ErrAuthNotCritical) Error() string

Error implements the error interface.

type ErrNoOnePublishing

type ErrNoOnePublishing struct {
	PathName string
}

ErrNoOnePublishing is a "no one is publishing" error.

func (ErrNoOnePublishing) Error

func (e ErrNoOnePublishing) Error() string

Error implements the error interface.

type Path

type Path interface {
	Name() string
	Conf() *conf.PathConf
	OnClientRemove(RemoveReq)
	OnClientPlay(PlayReq)
	OnClientRecord(RecordReq)
	OnClientPause(PauseReq)
	OnClientStartingPoint(StartingPointReq)
	OnFrame(int, gortsplib.StreamType, []byte)
}

Path is implemented by path.Path.

type PauseReq

type PauseReq struct {
	Client Client
	Res    chan struct{}
}

PauseReq is a pause request.

type PlayReq

type PlayReq struct {
	Client Client
	Res    chan PlayRes
}

PlayReq is a play request.

type PlayRes

type PlayRes struct {
	TrackStartingPoints []*TrackStartingPoint
}

PlayRes is a play response.

type RecordReq

type RecordReq struct {
	Client Client
	Res    chan struct{}
}

RecordReq is a record request.

type RemoveReq

type RemoveReq struct {
	Client Client
	Res    chan struct{}
}

RemoveReq is a remove request.

type SetupPlayReq

type SetupPlayReq struct {
	Client   Client
	PathName string
	Data     interface{}
	Res      chan SetupPlayRes
}

SetupPlayReq is a setup/play request.

type SetupPlayRes

type SetupPlayRes struct {
	Path   Path
	Tracks gortsplib.Tracks
	Err    error
}

SetupPlayRes is a setup/play response.

type StartingPointReq

type StartingPointReq struct {
	Client  Client
	TrackID int
	SP      *TrackStartingPoint
}

StartingPointReq is a starting point request.

type TrackStartingPoint

type TrackStartingPoint struct {
	Filled         bool // used by clientrtsp to avoid mutexes
	SequenceNumber uint16
	Timestamp      uint32
}

TrackStartingPoint is the starting point of a track.