record

Documentation

Index

• Variables
• type Recorder
• type Recording
  • func Record(r Recorder, name string, opts *ari.RecordingOptions) (rec *Recording)
  • func (r *Recording) Cancel()
  • func (r *Recording) Data() *ari.LiveRecordingData
  • func (r *Recording) Done() chan struct{}
  • func (r *Recording) Err() error
  • func (r *Recording) Handle() *ari.LiveRecordingHandle
  • func (r *Recording) Status() Status
• type Status
  • func (i Status) String() string

Variables

var Logger = log15.New()

Logger defaults to a discard handler (null output). If you wish to enable logging, you can set your own handler like so:

ari.Logger.SetHandler(log15.StderrHandler)

var RecordingStartTimeout = 1 * time.Second

RecordingStartTimeout is the amount of time to wait for a recording to start before declaring the recording to have failed.

Types

type Recorder

type Recorder interface {
	Record(string, *ari.RecordingOptions) (*ari.LiveRecordingHandle, error)

	StageRecord(string, *ari.RecordingOptions) (*ari.LiveRecordingHandle, error)

	Subscribe(...string) ari.Subscription
}

A Recorder is anything which can "Record"

type Recording

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

A Recording is a lifecycle managed audio recording

func Record

func Record(r Recorder, name string, opts *ari.RecordingOptions) (rec *Recording)

Record starts a recording on the given Recorder. TODO: simplify nolint:gocyclo

func (*Recording) Cancel

func (r *Recording) Cancel()

Cancel cancels the recording

func (*Recording) Data

func (r *Recording) Data() *ari.LiveRecordingData

Data returns the live recording handle data saved at the end of recording event

func (*Recording) Done

func (r *Recording) Done() chan struct{}

Done returns a channel that is closed when the recording is done

func (*Recording) Err

func (r *Recording) Err() error

Err returns any errors in the recording

func (*Recording) Handle

func (r *Recording) Handle() *ari.LiveRecordingHandle

Handle records the live recording handle

func (*Recording) Status

func (r *Recording) Status() Status

Status returns the status of the recording

type Status

type Status int64

Status is the indicator for recording status

const (
	// InProgress indicates that a recording is still in progress
	InProgress Status = iota

	// Canceled indicates that a recording was canceled (by request)
	Canceled

	// Failed indicates that a recording failed
	Failed

	// Finished indicates that a recording finished normally
	Finished

	// Hangup indicates that a recording was ended due to hangup
	Hangup
)

func (Status) String

func (i Status) String() string