Documentation
¶
Index ¶
- func AssetsPreviewsDeleteCommand() *ffcli.Command
- func AssetsPreviewsDownloadCommand() *ffcli.Command
- func AssetsPreviewsListCommand() *ffcli.Command
- func AssetsPreviewsSetPosterFrameCommand() *ffcli.Command
- func AssetsPreviewsUploadCommand() *ffcli.Command
- func AssetsScreenshotsApplyCommand() *ffcli.Command
- func AssetsScreenshotsDeleteCommand() *ffcli.Command
- func AssetsScreenshotsDownloadCommand() *ffcli.Command
- func AssetsScreenshotsListCommand() *ffcli.Command
- func AssetsScreenshotsPlanCommand() *ffcli.Command
- func AssetsScreenshotsSizesCommand() *ffcli.Command
- func AssetsScreenshotsUploadCommand() *ffcli.Command
- func AssetsScreenshotsValidateCommand() *ffcli.Command
- func CollectAssetFiles(path string) ([]string, error)
- func ContextWithAssetUploadTimeout(ctx context.Context) (context.Context, context.CancelFunc)
- func DownloadMediaURL(ctx context.Context, url, outputPath string, overwrite bool) (int64, string, error)
- func ExecuteScreenshotSetUpload[T any](ctx context.Context, opts ScreenshotSetUploadOptions[T]) (T, error)
- func GetOrderedAppScreenshotIDs(ctx context.Context, client *asc.Client, setID string) ([]string, error)
- func IsHLSPlaylist(contentType, rawURL string) bool
- func NormalizePreviewType(input string) (string, error)
- func ResolveImageAssetDownloadURL(asset *asc.ImageAsset, fileName string) (string, error)
- func SetOrderedAppScreenshots(ctx context.Context, client *asc.Client, setID string, orderedIDs []string) error
- func UploadPreviewAsset(ctx context.Context, client *asc.Client, setID, filePath string) (asc.AssetUploadResultItem, error)
- func UploadPreviewFiles(uploadCtx, rollbackBase context.Context, client *asc.Client, setID string, ...) ([]asc.AssetUploadResultItem, []asc.AssetUploadFailureItem, error)
- func UploadScreenshotAssetsConcurrently(ctx context.Context, client *asc.Client, setID string, files []string, ...) ([]asc.AssetUploadResultItem, string, error)
- func ValidPreviewFrameTimeCode(tc string) bool
- func ValidatePreviewFiles(files []string, enforceCapacity bool) error
- type ScreenshotSetAccess
- type ScreenshotSetCreateFunc
- type ScreenshotSetListFunc
- type ScreenshotSetUploadOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AssetsPreviewsDeleteCommand ¶
AssetsPreviewsDeleteCommand returns the preview delete subcommand.
func AssetsPreviewsDownloadCommand ¶
AssetsPreviewsDownloadCommand returns the previews download subcommand.
func AssetsPreviewsListCommand ¶
AssetsPreviewsListCommand returns the previews list subcommand.
func AssetsPreviewsSetPosterFrameCommand ¶ added in v1.260325.0
AssetsPreviewsSetPosterFrameCommand returns the set-poster-frame subcommand.
func AssetsPreviewsUploadCommand ¶
AssetsPreviewsUploadCommand returns the previews upload subcommand.
func AssetsScreenshotsApplyCommand ¶ added in v1.260404.0
AssetsScreenshotsApplyCommand returns the screenshots apply subcommand.
func AssetsScreenshotsDeleteCommand ¶
AssetsScreenshotsDeleteCommand returns the screenshot delete subcommand.
func AssetsScreenshotsDownloadCommand ¶
AssetsScreenshotsDownloadCommand returns the screenshots download subcommand.
func AssetsScreenshotsListCommand ¶
AssetsScreenshotsListCommand returns the screenshots list subcommand.
func AssetsScreenshotsPlanCommand ¶ added in v1.260404.0
AssetsScreenshotsPlanCommand returns the screenshots plan subcommand.
func AssetsScreenshotsSizesCommand ¶
AssetsScreenshotsSizesCommand returns the screenshots sizes subcommand.
func AssetsScreenshotsUploadCommand ¶
AssetsScreenshotsUploadCommand returns the screenshots upload subcommand.
func AssetsScreenshotsValidateCommand ¶ added in v1.260407.0
AssetsScreenshotsValidateCommand returns the screenshots validate subcommand.
func CollectAssetFiles ¶
CollectAssetFiles validates and collects files from a path.
func ContextWithAssetUploadTimeout ¶
ContextWithAssetUploadTimeout returns a context with the asset upload timeout.
func DownloadMediaURL ¶
func DownloadMediaURL(ctx context.Context, url, outputPath string, overwrite bool) (int64, string, error)
DownloadMediaURL downloads an unauthenticated media URL using the asset transfer path.
func ExecuteScreenshotSetUpload ¶ added in v1.260404.0
func ExecuteScreenshotSetUpload[T any](ctx context.Context, opts ScreenshotSetUploadOptions[T]) (T, error)
ExecuteScreenshotSetUpload validates flags/files and runs the shared screenshot upload/sync flow for a localization-backed screenshot set.
func GetOrderedAppScreenshotIDs ¶
func GetOrderedAppScreenshotIDs(ctx context.Context, client *asc.Client, setID string) ([]string, error)
GetOrderedAppScreenshotIDs returns screenshot IDs in the current remote order.
func IsHLSPlaylist ¶
IsHLSPlaylist reports whether a preview download is an HLS playlist; pass an empty contentType to decide from the URL alone before downloading.
func NormalizePreviewType ¶
NormalizePreviewType normalizes and validates a preview type.
func ResolveImageAssetDownloadURL ¶
func ResolveImageAssetDownloadURL(asset *asc.ImageAsset, fileName string) (string, error)
ResolveImageAssetDownloadURL expands an ASC delivery template for an exported image.
func SetOrderedAppScreenshots ¶
func SetOrderedAppScreenshots(ctx context.Context, client *asc.Client, setID string, orderedIDs []string) error
SetOrderedAppScreenshots replaces the screenshot relationships for a set in the provided order.
func UploadPreviewAsset ¶
func UploadPreviewAsset(ctx context.Context, client *asc.Client, setID, filePath string) (asc.AssetUploadResultItem, error)
UploadPreviewAsset uploads a preview file to a set.
func UploadPreviewFiles ¶
func UploadPreviewFiles(uploadCtx, rollbackBase context.Context, client *asc.Client, setID string, setCreated bool, files []string) ([]asc.AssetUploadResultItem, []asc.AssetUploadFailureItem, error)
UploadPreviewFiles uploads previews and rolls back resources created by this run on failure. setCreated must be true only when this run created the preview set.
func UploadScreenshotAssetsConcurrently ¶
func UploadScreenshotAssetsConcurrently(ctx context.Context, client *asc.Client, setID string, files []string, uploadContext func(context.Context) (context.Context, context.CancelFunc), open func(filePath string) (*os.File, error)) ([]asc.AssetUploadResultItem, string, error)
UploadScreenshotAssetsConcurrently uploads files into setID with the screenshot upload worker pool. Each upload runs under its own context from uploadContext and reads the handle from open, which it closes; a nil handle uploads from the path. Results keep file order. On failure it returns the results before the first failed file, that file, and the error, and deletes the screenshots uploaded after it.
func ValidPreviewFrameTimeCode ¶
ValidPreviewFrameTimeCode reports whether a timecode matches the upload contract.
func ValidatePreviewFiles ¶
ValidatePreviewFiles checks preview capacity, image contents, and extension before any destructive sync. enforceCapacity rejects more than three files.
Types ¶
type ScreenshotSetAccess ¶ added in v1.260404.0
type ScreenshotSetAccess struct {
List ScreenshotSetListFunc
Create ScreenshotSetCreateFunc
}
ScreenshotSetAccess contains the list/create hooks for a screenshot-set owner.
type ScreenshotSetCreateFunc ¶ added in v1.260404.0
type ScreenshotSetCreateFunc func(context.Context, *asc.Client, string, string) (*asc.AppScreenshotSetResponse, error)
ScreenshotSetCreateFunc creates a screenshot set for a localization kind.
type ScreenshotSetListFunc ¶ added in v1.260404.0
type ScreenshotSetListFunc func(context.Context, *asc.Client, string, asc.RequestContextFunc) (*asc.AppScreenshotSetsResponse, error)
ScreenshotSetListFunc fetches screenshot sets for a localization kind.
type ScreenshotSetUploadOptions ¶ added in v1.260404.0
type ScreenshotSetUploadOptions[T any] struct { LocalizationID string Path string DeviceType string Replace bool // InspectCommand is the owner-specific read-only command shown when the // target screenshot set is full or has ambiguous checksum matches. InspectCommand string // ReplaceCommand is the owner-specific replacement command shown when the // target screenshot set is full. ReplaceCommand string InvalidDeviceTypeIsUsage bool ClientFactory func() (*asc.Client, error) RequestContext func(context.Context) (context.Context, context.CancelFunc) UploadContext func(context.Context) (context.Context, context.CancelFunc) Access ScreenshotSetAccess BuildResult func(string, asc.Resource[asc.AppScreenshotSetAttributes], []asc.AssetUploadResultItem) T }
ScreenshotSetUploadOptions configures the shared screenshot upload path for custom product pages and PPO treatment localizations.
Source Files
¶
- assets_download_helpers.go
- assets_helpers.go
- assets_order.go
- assets_previews.go
- assets_screenshot_concurrency.go
- assets_screenshot_order.go
- assets_screenshots.go
- assets_screenshots_delete.go
- assets_screenshots_discovery.go
- assets_screenshots_download.go
- assets_screenshots_duplicates.go
- assets_screenshots_resume.go
- assets_screenshots_review_plan.go
- assets_screenshots_upload.go
- assets_screenshots_validate.go