elements

Documentation

Index

• Constants
• Variables
• type Converter
  • func NewConverter(config ConverterConfig) *Converter
  • func (d *Converter) Attach(e avp.Element) error
  • func (d *Converter) Close()
  • func (d *Converter) ID() string
  • func (d *Converter) Write(sample *avp.Sample) error
• type ConverterConfig
• type Decoder
  • func NewDecoder(config DecoderConfig) *Decoder
  • func (d *Decoder) Attach(e avp.Element) error
  • func (d *Decoder) Close()
  • func (d *Decoder) ID() string
  • func (d *Decoder) Write(sample *avp.Sample) error
• type DecoderConfig
• type FileWriter
  • func NewFileWriter(config FileWriterConfig) *FileWriter
  • func (w *FileWriter) Attach(e avp.Element) error
  • func (w *FileWriter) Close()
  • func (w *FileWriter) ID() string
  • func (w *FileWriter) Write(sample *avp.Sample) error
• type FileWriterConfig
• type SampleWriter
  • func NewSampleWriter() *SampleWriter
  • func (w *SampleWriter) Attach(e avp.Element) error
  • func (w *SampleWriter) Close() error
  • func (w *SampleWriter) Write(p []byte) (n int, err error)
• type WebmSaver
  • func NewWebmSaver(config WebmSaverConfig) *WebmSaver
  • func (s *WebmSaver) Attach(e avp.Element) error
  • func (s *WebmSaver) Close()
  • func (s *WebmSaver) ID() string
  • func (s *WebmSaver) Write(sample *avp.Sample) error
• type WebmSaverConfig

Constants

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

Types for samples

const (
	// IDConverter .
	IDConverter = "converter"
)

const (
	// IDDecoder .
	IDDecoder = "decoder"
)

const (
	// IDFileWriter .
	IDFileWriter = "FileWriter"
)

const (
	// IDWebmSaver .
	IDWebmSaver = "WebmSaver"
)

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 {
	// contains filtered or unexported fields
}

Converter instance

func NewConverter

func NewConverter(config ConverterConfig) *Converter

NewConverter instance. Converter converts between media types.

Currently supports:

• YCbCR -> JPEG

func (*Converter) Attach

func (d *Converter) Attach(e avp.Element) error

Attach attach a child element

func (*Converter) Close

func (d *Converter) Close()

Close Converter

func (*Converter) ID

func (d *Converter) ID() string

ID for Converter

func (*Converter) Write

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

type ConverterConfig

type ConverterConfig struct {
	ID   string `json:"id"`
	Type int    `json:"type"`
}

ConverterConfig .

type Decoder

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

Decoder instance

func NewDecoder

func NewDecoder(config DecoderConfig) *Decoder

NewDecoder instance. Decoder takes as input VP8 keyframes and decodes it into a YCbCr image.

func (*Decoder) Attach

func (d *Decoder) Attach(e avp.Element) error

Attach attach a child element

func (*Decoder) Close

func (d *Decoder) Close()

Close Decoder

func (*Decoder) ID

func (d *Decoder) ID() string

ID for Decoder

func (*Decoder) Write

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

type DecoderConfig

type DecoderConfig struct {
	ID string `json:"id"`
}

DecoderConfig .

type FileWriter

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

FileWriter instance

func NewFileWriter

func NewFileWriter(config FileWriterConfig) *FileWriter

NewFileWriter instance

func (*FileWriter) Attach

func (w *FileWriter) Attach(e avp.Element) error

Attach attach a child element

func (*FileWriter) Close

func (w *FileWriter) Close()

Close FileWriter

func (*FileWriter) ID

func (w *FileWriter) ID() string

ID for FileWriter

func (*FileWriter) Write

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

type FileWriterConfig

type FileWriterConfig struct {
	ID   string
	Path string
}

FileWriterConfig .

type SampleWriter

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

SampleWriter for writing samples

func NewSampleWriter

func NewSampleWriter() *SampleWriter

NewSampleWriter creates a new sample writer

func (*SampleWriter) Attach

func (w *SampleWriter) Attach(e avp.Element) error

Attach a child element

func (*SampleWriter) Close

func (w *SampleWriter) Close() error

Close writer

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(config WebmSaverConfig) *WebmSaver

NewWebmSaver Initialize a new webm saver

func (*WebmSaver) Attach

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

Attach attach a child element

func (*WebmSaver) Close

func (s *WebmSaver) Close()

Close Close the WebmSaver

func (*WebmSaver) ID

func (s *WebmSaver) ID() string

ID of element

func (*WebmSaver) Write

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

Write sample to webmsaver

type WebmSaverConfig

type WebmSaverConfig struct {
	ID string
}

WebmSaverConfig .