params

Documentation

Index

• Constants
• Variables
• type AudioParams
• type EgressType
• type FileExtension
• type FileParams
• type MimeType
• type OutputType
• type Params
  • func GetPipelineParams(conf *config.Config, request *livekit.StartEgressRequest) (p *Params, err error)
  • func (p *Params) UpdateOutputTypeFromCodecs(fileIdentifier string) error
  • func (p *Params) VerifyUrl(url string) error
• type Profile
• type SourceParams
• type StreamParams
• type VideoParams

Constants

const (
	// input types
	MimeTypeAAC  MimeType = "audio/aac"
	MimeTypeOpus MimeType = "audio/opus"
	MimeTypeRaw  MimeType = "audio/x-raw"
	MimeTypeH264 MimeType = "video/h264"
	MimeTypeVP8  MimeType = "video/vp8"

	// video profiles
	ProfileBaseline Profile = "baseline"
	ProfileMain     Profile = "main"
	ProfileHigh     Profile = "high"

	// egress types
	EgressTypeStream    EgressType = "stream"
	EgressTypeWebsocket EgressType = "websocket"
	EgressTypeFile      EgressType = "file"

	// output types
	OutputTypeRaw  OutputType = "audio/x-raw"
	OutputTypeOGG  OutputType = "audio/ogg"
	OutputTypeIVF  OutputType = "video/x-ivf"
	OutputTypeMP4  OutputType = "video/mp4"
	OutputTypeTS   OutputType = "video/mp2t"
	OutputTypeWebM OutputType = "video/webm"
	OutputTypeRTMP OutputType = "rtmp"

	// file extensions
	FileExtensionRaw  = ".raw"
	FileExtensionOGG  = ".ogg"
	FileExtensionIVF  = ".ivf"
	FileExtensionMP4  = ".mp4"
	FileExtensionTS   = ".ts"
	FileExtensionWebM = ".webm"
)

Variables

var (
	DefaultAudioCodecs = map[OutputType]MimeType{
		OutputTypeRaw:  MimeTypeRaw,
		OutputTypeOGG:  MimeTypeOpus,
		OutputTypeMP4:  MimeTypeAAC,
		OutputTypeTS:   MimeTypeAAC,
		OutputTypeWebM: MimeTypeOpus,
		OutputTypeRTMP: MimeTypeAAC,
	}

	DefaultVideoCodecs = map[OutputType]MimeType{
		OutputTypeIVF:  MimeTypeVP8,
		OutputTypeMP4:  MimeTypeH264,
		OutputTypeTS:   MimeTypeH264,
		OutputTypeWebM: MimeTypeVP8,
		OutputTypeRTMP: MimeTypeH264,
	}

	FileExtensions = map[OutputType]FileExtension{
		OutputTypeRaw:  FileExtensionRaw,
		OutputTypeOGG:  FileExtensionOGG,
		OutputTypeIVF:  FileExtensionIVF,
		OutputTypeMP4:  FileExtensionMP4,
		OutputTypeTS:   FileExtensionTS,
		OutputTypeWebM: FileExtensionWebM,
	}
)

Types

type AudioParams

type AudioParams struct {
	AudioEnabled   bool
	AudioCodec     MimeType
	AudioBitrate   int32
	AudioFrequency int32
}

type EgressType

type EgressType string

type FileExtension

type FileExtension string

type FileParams

type FileParams struct {
	FileInfo   *livekit.FileInfo
	Filename   string
	Filepath   string
	FileUpload interface{}
}

type MimeType

type MimeType string

type OutputType

type OutputType string

type Params

type Params struct {
	Logger logger.Logger
	Info   *livekit.EgressInfo

	SourceParams
	AudioParams
	VideoParams

	EgressType
	OutputType

	MutedChan chan bool
	StreamParams
	FileParams
}

func GetPipelineParams

func GetPipelineParams(conf *config.Config, request *livekit.StartEgressRequest) (p *Params, err error)

GetPipelineParams must always return params, even on error

func (*Params) UpdateOutputTypeFromCodecs

func (p *Params) UpdateOutputTypeFromCodecs(fileIdentifier string) error

used for sdk input source

func (*Params) VerifyUrl

func (p *Params) VerifyUrl(url string) error

type Profile

type Profile string

type SourceParams

type SourceParams struct {
	// source
	RoomName     string
	Token        string
	LKUrl        string
	TemplateBase string
	IsWebSource  bool

	// web source
	Display        string
	Layout         string
	CustomBase     string
	CustomInputURL string

	// sdk source
	TrackID      string
	AudioTrackID string
	VideoTrackID string
}

type StreamParams

type StreamParams struct {
	WebsocketUrl string
	StreamUrls   []string
	StreamInfo   map[string]*livekit.StreamInfo
}

type VideoParams

type VideoParams struct {
	VideoEnabled bool
	VideoCodec   MimeType
	VideoProfile Profile
	Width        int32
	Height       int32
	Depth        int32
	Framerate    int32
	VideoBitrate int32
}