params

Documentation

Index

• Constants
• Variables
• func ValidateRequest(ctx context.Context, conf *config.Config, request *livekit.StartEgressRequest) (*livekit.EgressInfo, error)
• type AudioParams
• type EgressType
• type FileExtension
• type FileParams
• type Manifest
• type MimeType
• type OutputType
• type Params
  • func GetPipelineParams(ctx context.Context, conf *config.Config, request *livekit.StartEgressRequest) (*Params, error)
  • func (p *Params) GetManifest() ([]byte, error)
  • func (p *Params) GetSegmentOutputType() OutputType
  • func (p *Params) GetSessionTimeout() time.Duration
  • func (p *Params) UpdateFileInfoFromSDK(fileIdentifier string, replacements map[string]string) error
  • func (p *Params) UpdatePlaylistNamesFromSDK(replacements map[string]string)
  • func (p *Params) UpdatePrefixAndPlaylist(identifier string, replacements map[string]string) error
  • func (p *Params) VerifyUrl(url string) error
• type Profile
• type SegmentedFileParams
  • func (p *SegmentedFileParams) GetStorageFilepath(filename string) string
• type SourceParams
• type StreamParams
• type UploadParams
• 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"
	EgressTypeSegmentedFile EgressType = "segments"

	// 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"
	OutputTypeHLS  OutputType = "application/x-mpegurl"

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

Variables

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

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

	FileExtensions = map[FileExtension]struct{}{
		FileExtensionRaw:  {},
		FileExtensionOGG:  {},
		FileExtensionIVF:  {},
		FileExtensionMP4:  {},
		FileExtensionTS:   {},
		FileExtensionWebM: {},
		FileExtensionM3U8: {},
	}

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

Functions

func ValidateRequest

func ValidateRequest(ctx context.Context, conf *config.Config, request *livekit.StartEgressRequest) (*livekit.EgressInfo, error)

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
	LocalFilepath   string
	StorageFilepath string
}

type Manifest

type Manifest struct {
	EgressID          string `json:"egress_id,omitempty"`
	RoomID            string `json:"room_id,omitempty"`
	RoomName          string `json:"room_name,omitempty"`
	StartedAt         int64  `json:"started_at,omitempty"`
	EndedAt           int64  `json:"ended_at,omitempty"`
	PublisherIdentity string `json:"publisher_identity,omitempty"`
	TrackID           string `json:"track_id,omitempty"`
	TrackKind         string `json:"track_kind,omitempty"`
	TrackSource       string `json:"track_source,omitempty"`
	AudioTrackID      string `json:"audio_track_id,omitempty"`
	VideoTrackID      string `json:"video_track_id,omitempty"`
	SegmentCount      int64  `json:"segment_count,omitempty"`
}

type MimeType

type MimeType string

type OutputType

type OutputType string

type Params

type Params struct {
	Logger   logger.Logger
	Info     *livekit.EgressInfo
	GstReady chan struct{}

	SourceParams
	AudioParams
	VideoParams

	EgressType
	OutputType

	MutedChan chan bool
	StreamParams
	FileParams
	SegmentedFileParams

	UploadParams
	// contains filtered or unexported fields
}

func GetPipelineParams

func GetPipelineParams(ctx context.Context, conf *config.Config, request *livekit.StartEgressRequest) (*Params, error)

func (*Params) GetManifest

func (p *Params) GetManifest() ([]byte, error)

func (*Params) GetSegmentOutputType

func (p *Params) GetSegmentOutputType() OutputType

func (*Params) GetSessionTimeout

func (p *Params) GetSessionTimeout() time.Duration

func (*Params) UpdateFileInfoFromSDK

func (p *Params) UpdateFileInfoFromSDK(fileIdentifier string, replacements map[string]string) error

used for sdk input source

func (*Params) UpdatePlaylistNamesFromSDK

func (p *Params) UpdatePlaylistNamesFromSDK(replacements map[string]string)

func (*Params) UpdatePrefixAndPlaylist

func (p *Params) UpdatePrefixAndPlaylist(identifier string, replacements map[string]string) error

func (*Params) VerifyUrl

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

type Profile

type Profile string

type SegmentedFileParams

type SegmentedFileParams struct {
	SegmentsInfo      *livekit.SegmentsInfo
	LocalFilePrefix   string
	StoragePathPrefix string
	PlaylistFilename  string
	SegmentDuration   int
}

func (*SegmentedFileParams) GetStorageFilepath

func (p *SegmentedFileParams) GetStorageFilepath(filename string) string

type SourceParams

type SourceParams struct {
	// source
	Token        string
	LKUrl        string
	TemplateBase string

	// web source
	Display    string
	Layout     string
	CustomBase string

	// sdk source
	TrackID             string
	TrackSource         string
	TrackKind           string
	AudioTrackID        string
	VideoTrackID        string
	ParticipantIdentity string
}

type StreamParams

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

type UploadParams

type UploadParams struct {
	UploadConfig    interface{}
	DisableManifest bool
}

type VideoParams

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