egress

Documentation

Index

• Constants
• Variables
• func BuildEgressToken(egressID, apiKey, secret, roomName string) (string, error)
• func GetOutputType(req interface{}) string
• func GetTypes(request interface{}) (string, string)
• type DirectOutput
• type EncodedOutput
• type EncodedOutputDeprecated

Constants

const (
	EgressTypeRoomComposite  = "room_composite"
	EgressTypeWeb            = "web"
	EgressTypeParticipant    = "participant"
	EgressTypeTrackComposite = "track_composite"
	EgressTypeTrack          = "track"

	OutputTypeFile     = "file"
	OutputTypeStream   = "stream"
	OutputTypeSegments = "segments"
	OutputTypeImages   = "images"
	OutputTypeMultiple = "multiple"

	Unknown = "unknown"
)

Variables

var (
	ErrNoResponse     = errors.New("no response from egress service")
	ErrEgressTimedOut = errors.New("egress timed out")
)

Functions

func BuildEgressToken

func BuildEgressToken(egressID, apiKey, secret, roomName string) (string, error)

func GetOutputType

func GetOutputType(req interface{}) string

func GetTypes

func GetTypes(request interface{}) (string, string)

Types

type DirectOutput

type DirectOutput interface {
	GetFile() *livekit.DirectFileOutput
	GetWebsocketUrl() string
}

type EncodedOutput

type EncodedOutput interface {
	GetFileOutputs() []*livekit.EncodedFileOutput
	GetStreamOutputs() []*livekit.StreamOutput
	GetSegmentOutputs() []*livekit.SegmentedFileOutput
	GetImageOutputs() []*livekit.ImageOutput
}

type EncodedOutputDeprecated

type EncodedOutputDeprecated interface {
	GetFile() *livekit.EncodedFileOutput
	GetStream() *livekit.StreamOutput
	GetSegments() *livekit.SegmentedFileOutput
}