waxtap

package module

Go to main page

Versions in this module

v1

v1.5.0

Jun 9, 2026

Changes in this version

type Options

+ Client string

+ Session *POTokenSession

+ SessionProvider POTokenSessionProvider

+ type POTokenProviderFunc = potoken.ProviderFunc

+ type POTokenSession = potoken.Session

+ type POTokenSessionProvider = potoken.SessionProvider

v1.4.3

Jun 8, 2026

retracted

v1.4.2

Jun 8, 2026

retracted

v1.4.1

Jun 8, 2026

retracted

v1.4.0

Jun 7, 2026

retracted

v1.3.0

Jun 6, 2026

Changes in this version

type Client

+ func (c *Client) DownloadPlaylist(ctx context.Context, url string, o PlaylistDownloadOptions) (*PlaylistRunResult, error)

+ type PlaylistDownloadOptions struct

+ Concurrency int

+ MaxDownloads int

+ MaxItems int

+ MaxSleepInterval time.Duration

+ OnItem func(PlaylistItemOutcome)

+ Resolve func(ctx context.Context, e PlaylistEntry) (req Request, skip string, err error)

+ SleepInterval time.Duration

+ type PlaylistItemOutcome struct

+ Attempted bool

+ Entry PlaylistEntry

+ Err error

+ Result *Result

+ SkipReason string

+ type PlaylistRunResult struct

+ CapReached bool

+ DownloadFailed int

+ Downloaded int

+ EnumErrors []error

+ Enumerated int

+ Outcomes []PlaylistItemOutcome

+ Remaining int

+ ResolveFailed int

+ Skipped int

v1.2.0

Jun 6, 2026

Changes in this version

+ const QualityHigh

+ const QualityLow

+ const QualityMedium

+ const QualityUltraLow

+ const QualityUnknown

+ type AudioQualityTier = format.AudioQualityTier

type Options

+ ChromeMajor int

v1.1.0

Jun 5, 2026

v1.0.1

Jun 5, 2026

v1.0.0

Jun 4, 2026

retracted

Changes in this version

+ const No

+ const Unknown

+ const Yes

+ var ErrCipherSolve = waxerr.ErrCipherSolve

+ var ErrExtractionFailed = waxerr.ErrExtractionFailed

+ var ErrFFmpegNotFound = waxerr.ErrFFmpegNotFound

+ var ErrIncompatibleSpec = waxerr.ErrIncompatibleSpec

+ var ErrInvalidPlaylistID = waxerr.ErrInvalidPlaylistID

+ var ErrInvalidVideoID = waxerr.ErrInvalidVideoID

+ var ErrIsPlaylist = waxerr.ErrIsPlaylist

+ var ErrLiveContent = waxerr.ErrLiveContent

+ var ErrLoginRequired = waxerr.ErrLoginRequired

+ var ErrNeedsPOToken = waxerr.ErrNeedsPOToken

+ var ErrNoAudioFormats = waxerr.ErrNoAudioFormats

+ var ErrNoMatch = format.ErrNoMatch

+ var ErrNotImplemented = errors.New("waxtap: not implemented")

+ var ErrRateLimited = waxerr.ErrRateLimited

+ var ErrURLExpired = waxerr.ErrURLExpired

+ var ErrUnsupportedInput = waxerr.ErrUnsupportedInput

+ var ErrVideoRestricted = waxerr.ErrVideoRestricted

+ var ErrVideoUnavailable = waxerr.ErrVideoUnavailable

+ func BestForTarget(candidates []Format, policy SourcePolicy, target Target) (int, error)

+ type AlbumLoudnessResult struct

+ Album LoudnessInfo

+ PerTrack []LoudnessInfo

+ type AlbumProcessResult struct

+ Album LoudnessInfo

+ GainDB float64

+ Outputs []string

+ PerTrack []LoudnessInfo

+ type AlbumTrack struct

+ Input string

+ Output string

+ type AudioSelector = format.AudioSelector

+ func BestAudio() AudioSelector

+ func Codec(codec string) AudioSelector

+ func Itag(itag int) AudioSelector

+ type AudioTrack = format.AudioTrack

+ type Chapter = youtube.Chapter

+ type Client struct

+ func New(opts Options) (*Client, error)

+ func (c *Client) Download(ctx context.Context, req Request) (res *Result, err error)

+ func (c *Client) Enumerate(ctx context.Context, url string, opts EnumerateOptions) (*Playlist, error)

+ func (c *Client) Info(ctx context.Context, url string, depth InfoDepth) (*Video, error)

+ func (c *Client) MeasureAlbum(ctx context.Context, paths []string) (*AlbumLoudnessResult, error)

+ func (c *Client) Process(ctx context.Context, req ProcessRequest) (res *Result, err error)

+ func (c *Client) ProcessAlbum(ctx context.Context, tracks []AlbumTrack, target float64, spec TranscodeSpec) (*AlbumProcessResult, error)

+ func (c *Client) Resolve(ctx context.Context, url string, sel AudioSelector) (ResolvedStream, error)

+ func (c *Client) SponsorBlockSegments(ctx context.Context, videoURL string, categories []sponsorblock.Category) ([]sponsorblock.Segment, error)

+ func (c *Client) Stream(ctx context.Context, req Request) (rc io.ReadCloser, info StreamInfo, err error)

+ type Concurrency struct

+ Chunks int

+ Downloads int

+ FFmpeg int

+ type CutMode uint8

+ const CutAccurate

+ const CutCopy

+ const CutSmart

+ type CutSpec struct

+ Crossfade time.Duration

+ Mode CutMode

+ OnError SponsorBlockErrorPolicy

+ Ranges []TimeRange

+ SponsorBlock []sponsorblock.Category

+ Timeout time.Duration

+ type EnumerateOptions struct

+ Enrich bool

+ MaxItems int

+ type Event struct

+ Bytes int64

+ Err error

+ ItemCount int

+ ItemIndex int

+ Message string

+ Stage Stage

+ Total int64

+ VideoID string

+ Warning *Warning

+ type ExtractionError = waxerr.ExtractionError

+ type Format = format.Format

+ type HTTPStatusError = waxerr.HTTPStatusError

+ type InfoDepth uint8

+ const InfoBasic

+ const InfoProbe

+ const InfoResolved

+ type Locale struct

+ GL string

+ HL string

+ type LoudnessInfo struct

+ IntegratedLUFS float64

+ LRA float64

+ Threshold float64

+ TruePeakDBTP float64

+ type LoudnessMode uint8

+ const LoudnessApply

+ const LoudnessMeasureOnly

+ type LoudnessResult struct

+ Input *LoudnessInfo

+ Output *LoudnessInfo

+ Target float64

+ type LoudnessSpec struct

+ Mode LoudnessMode

+ Target float64

+ type Options struct

+ CacheDir string

+ Concurrency Concurrency

+ DisableDiskCache bool

+ HTTPClient *http.Client

+ Locale Locale

+ Logger *slog.Logger

+ MaxTempBytes int64

+ POTokenProvider POTokenProvider

+ Politeness Politeness

+ ProfileOverridePath string

+ Retry RetryPolicy

+ SponsorBlock SponsorBlockOptions

+ TempDir string

+ Timeouts Timeouts

+ type Output struct

+ func ToFile(path string) Output

+ func ToWriter(w io.Writer) Output

+ type POTokenProvider = potoken.Provider

+ type POTokenRequest = potoken.Request

+ type POTokenResponse = potoken.Response

+ type POTokenScope = potoken.Scope

+ type PlayabilityError = waxerr.PlayabilityError

+ type Playlist = youtube.Playlist

+ type PlaylistEntry = youtube.PlaylistEntry

+ type Politeness struct

+ Cooldown time.Duration

+ MaxDownloadsPerRun int

+ PerHostQPS float64

+ type ProcessRequest struct

+ Input string

+ type ProcessSpec struct

+ Cut *CutSpec

+ Events func(Event)

+ Loudness *LoudnessSpec

+ Output Output

+ SkipIfExists bool

+ Transcode *TranscodeSpec

+ type RateLimitError = waxerr.RateLimitError

+ type Request struct

+ Audio AudioSelector

+ SourcePolicy SourcePolicy

+ URL string

+ type ResolvedStream = youtube.ResolvedStream

+ type Result struct

+ CutApplied bool

+ InputPath string

+ Loudness *LoudnessResult

+ LoudnessApplied bool

+ LoudnessMeasured bool

+ OutputBytes int64

+ OutputFormat Format

+ OutputPath string

+ SourceBytes int64

+ SourceFormat Format

+ SourceKind SourceKind

+ SponsorBlockApplied bool

+ Title string

+ Transcoded bool

+ VideoID string

+ Warnings []Warning

+ type RetryPolicy struct

+ BaseBackoff time.Duration

+ MaxBackoff time.Duration

+ MaxRetries int

+ MaxRetryWait time.Duration

+ type SourceKind uint8

+ const SourceLocalFile

+ const SourceYouTube

+ func (k SourceKind) String() string

+ type SourcePolicy = format.SourcePolicy

+ func BestNative() SourcePolicy

+ func MinimizeLoss() SourcePolicy

+ func PreferCodec(codec string) SourcePolicy

+ type SponsorBlockErrorPolicy uint8

+ const FailDownload

+ const ProceedUncut

+ type SponsorBlockOptions struct

+ BaseURL string

+ Timeout time.Duration

+ type Stage uint8

+ const StageAnalyzing

+ const StageCutting

+ const StageDone

+ const StageDownloading

+ const StageExtracting

+ const StageFailed

+ const StageFinalizing

+ const StageNormalizing

+ const StageProbing

+ const StageResolving

+ const StageSkipped

+ const StageStaging

+ const StageTranscoding

+ const StageWarning

+ func (s Stage) String() string

+ type StreamInfo struct

+ ContentLength int64

+ Format Format

+ Title string

+ VideoID string

+ type Target = format.Target

+ type Thumbnail = youtube.Thumbnail

+ type TimeRange struct

+ End time.Duration

+ Start time.Duration

+ type Timeouts struct

+ ChunkRetry time.Duration

+ Extraction time.Duration

+ FFmpegShutdown time.Duration

+ Resolve time.Duration

+ SponsorBlock time.Duration

+ type TranscodeFormat uint8

+ const FormatAAC

+ const FormatALAC

+ const FormatCopy

+ const FormatFLAC

+ const FormatMP3

+ const FormatOpus

+ const FormatVorbis

+ const FormatWAV

+ type TranscodeSpec struct

+ Bitrate int

+ Format TranscodeFormat

+ type Tri = format.Tri

+ type Video = youtube.Video

+ type Warning struct

+ Code WarningCode

+ Detail string

+ type WarningCode uint8

+ const WarnFallbackProfile

+ const WarnPlaylistEntryFailed

+ const WarnProceedUncut

+ const WarnRangesEmpty

+ const WarnRateLimitedRetried

+ const WarnSponsorBlockEmpty

+ const WarnThrottled

+ const WarnURLReResolved

+ func (w WarningCode) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL