elements

README

ion-elements

A/V Processing Elements for Ion pipelines

Documentation

Index

• Constants
• Variables
• type FileWriter
  • func NewFileWriter(config FileWriterConfig) *FileWriter
  • func (w *FileWriter) Attach(e process.Element) error
  • func (w *FileWriter) Close()
  • func (w *FileWriter) Read() <-chan *samples.Sample
  • func (w *FileWriter) Type() string
  • func (w *FileWriter) Write(sample *samples.Sample) error
• type FileWriterConfig
• type ProtooBroadcast
  • func NewProtooBroadcast(config ProtooBroadcastConfig) *ProtooBroadcast
  • func (b *ProtooBroadcast) Attach(e process.Element) error
  • func (b *ProtooBroadcast) Close()
  • func (b *ProtooBroadcast) Read() <-chan *samples.Sample
  • func (b *ProtooBroadcast) Type() string
  • func (b *ProtooBroadcast) Write(sample *samples.Sample) error
• type ProtooBroadcastConfig
• type SampleWriter
  • func NewSampleWriter() *SampleWriter
  • func (w *SampleWriter) Attach(e process.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 process.Element) error
  • func (s *WebmSaver) Close()
  • func (s *WebmSaver) Read() <-chan *samples.Sample
  • func (s *WebmSaver) Type() string
  • func (s *WebmSaver) Write(sample *samples.Sample) error
• type WebmSaverConfig

Constants

const (
	TypeMetadata = 100
	TypeBinary   = 101
	TypeRGB24    = 102
	TypeWebM     = 103
)

Types for samples

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

const (
	// TypeProtooBroadcast .
	TypeProtooBroadcast = "ProtooBroadcast"
)

const (
	// TypeWebmSaver .
	TypeWebmSaver = "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 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 process.Element) error

Attach attach a child element

func (*FileWriter) Close

func (w *FileWriter) Close()

Close FileWriter

func (*FileWriter) Read

func (w *FileWriter) Read() <-chan *samples.Sample

func (*FileWriter) Type

func (w *FileWriter) Type() string

Type for FileWriter

func (*FileWriter) Write

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

type FileWriterConfig

type FileWriterConfig struct {
	ID   string
	Path string
}

FileWriterConfig .

type ProtooBroadcast

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

ProtooBroadcast instance

func NewProtooBroadcast

func NewProtooBroadcast(config ProtooBroadcastConfig) *ProtooBroadcast

NewProtooBroadcast instance

func (*ProtooBroadcast) Attach

func (b *ProtooBroadcast) Attach(e process.Element) error

Attach attach a child element

func (*ProtooBroadcast) Close

func (b *ProtooBroadcast) Close()

Close Protoobroadcast

func (*ProtooBroadcast) Read

func (b *ProtooBroadcast) Read() <-chan *samples.Sample

func (*ProtooBroadcast) Type

func (b *ProtooBroadcast) Type() string

Type for Protoobroadcast

func (*ProtooBroadcast) Write

func (b *ProtooBroadcast) Write(sample *samples.Sample) error

type ProtooBroadcastConfig

type ProtooBroadcastConfig struct {
	ID        string
	RID       string
	UID       string
	Requestor *nprotoo.Requestor
}

ProtooBroadcastConfig .

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 process.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 {
	// 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 process.Element) error

Attach attach a child element

func (*WebmSaver) Close

func (s *WebmSaver) Close()

Close Close the WebmSaver

func (*WebmSaver) Read

func (s *WebmSaver) Read() <-chan *samples.Sample

func (*WebmSaver) Type

func (s *WebmSaver) Type() string

Type of element

func (*WebmSaver) Write

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

Write sample to webmsaver

type WebmSaverConfig

type WebmSaverConfig struct {
	ID string
}

WebmSaverConfig .