elements

Documentation

Index

• Constants
• Variables
• type Converter
  • func NewConverter(typ int) *Converter
  • func (c *Converter) Write(sample *avp.Sample) error
• type Decoder
  • func NewDecoder(fps uint) *Decoder
  • func (dec *Decoder) Close()
  • func (dec *Decoder) Write(sample *avp.Sample) error
• type FileWriter
  • func NewFileWriter(path string) *FileWriter
  • func (w *FileWriter) Write(sample *avp.Sample) error
• type Filter
  • func NewFilter(condition func(*avp.Sample) bool) *Filter
  • func (f *Filter) Write(sample *avp.Sample) error
• type Leaf
  • func (e *Leaf) Attach(el avp.Element)
  • func (e *Leaf) Close()
  • func (e *Leaf) Write(sample *avp.Sample) error
• type Node
  • func (e *Node) Attach(el avp.Element)
  • func (e *Node) Close()
  • func (e *Node) Write(sample *avp.Sample) error
• type SampleWriter
  • func NewSampleWriter() *SampleWriter
  • func (w *SampleWriter) Close() error
  • func (w *SampleWriter) Write(p []byte) (n int, err error)
• type WebmSaver
  • func NewWebmSaver() *WebmSaver
  • func (s *WebmSaver) Attach(e avp.Element)
  • func (s *WebmSaver) Close()
  • func (s *WebmSaver) Write(sample *avp.Sample) error

Constants

const (
	TypeMetadata = 100
	TypeBinary   = 101
	TypeRGB24    = 102
	TypeWebM     = 103
	TypeYCbCr    = 104
	TypeJPEG     = 105
)

Types for samples

Variables

var (
	// ErrAttachNotSupported returned when attaching elements is not supported
	ErrAttachNotSupported = errors.New("attach not supported")
	// ErrElementAlreadyAttached returned when attaching an element that is already attached
	ErrElementAlreadyAttached = errors.New("element already attached")
)

Types

type Converter

type Converter struct {
	Node
	// contains filtered or unexported fields
}

Converter instance

func NewConverter

func NewConverter(typ int) *Converter

NewConverter instance. Converter converts between media types.

Currently supports:

• YCbCR -> JPEG

func (*Converter) Write

func (c *Converter) Write(sample *avp.Sample) error

type Decoder

type Decoder struct {
	Node
	// contains filtered or unexported fields
}

Decoder instance

func NewDecoder

func NewDecoder(fps uint) *Decoder

NewDecoder instance. Decoder takes as input VPX streams and decodes it into a YCbCr image.

func (*Decoder) Close

func (dec *Decoder) Close()

func (*Decoder) Write

func (dec *Decoder) Write(sample *avp.Sample) error

type FileWriter

type FileWriter struct {
	Leaf
	// contains filtered or unexported fields
}

FileWriter instance

func NewFileWriter

func NewFileWriter(path string) *FileWriter

NewFileWriter instance

func (*FileWriter) Write

func (w *FileWriter) Write(sample *avp.Sample) error

type Filter

type Filter struct {
	Node
	// contains filtered or unexported fields
}

Filter instance

func NewFilter

func NewFilter(condition func(*avp.Sample) bool) *Filter

NewFilter instance. Filter contitionally forwards a payload based on the return of the provided function.

func (*Filter) Write

func (f *Filter) Write(sample *avp.Sample) error

type Leaf

type Leaf struct{}

func (*Leaf) Attach

func (e *Leaf) Attach(el avp.Element)

func (*Leaf) Close

func (e *Leaf) Close()

func (*Leaf) Write

func (e *Leaf) Write(sample *avp.Sample) error

type Node

type Node struct {
	// contains filtered or unexported fields
}

func (*Node) Attach

func (e *Node) Attach(el avp.Element)

func (*Node) Close

func (e *Node) Close()

func (*Node) Write

func (e *Node) Write(sample *avp.Sample) error

type SampleWriter

type SampleWriter struct {
	Node
}

SampleWriter for writing samples

func NewSampleWriter

func NewSampleWriter() *SampleWriter

NewSampleWriter creates a new sample writer

func (*SampleWriter) Close

func (w *SampleWriter) Close() error

func (*SampleWriter) Write

func (w *SampleWriter) Write(p []byte) (n int, err error)

Write sample

type WebmSaver

type WebmSaver struct {
	sync.Mutex
	// contains filtered or unexported fields
}

WebmSaver Module for saving rtp streams to webm

func NewWebmSaver

func NewWebmSaver() *WebmSaver

NewWebmSaver Initialize a new webm saver

func (*WebmSaver) Attach

func (s *WebmSaver) Attach(e avp.Element)

Attach attach a child element

func (*WebmSaver) Close

func (s *WebmSaver) Close()

Close Close the WebmSaver

func (*WebmSaver) Write

func (s *WebmSaver) Write(sample *avp.Sample) error

Write sample to webmsaver