Class default

Index

Constructors

Methods

analyzeSteamCapsule createLibraryLogo cropSteamCapsule get getSteamCapsuleDimensions getSteamCapsuleInfo getSteamLibraryLogoRequirements getSteamScreenshotRequirements removeBackground removeBackgroundAI uploadBlob uploadFile validateScreenshot

Constructors

constructor

new default(): default
Returns default

Methods

`Static` analyzeSteamCapsule

analyzeSteamCapsule(request, params?): AxiosPromise<default<SteamCapsuleAnalysisResponse>>
Analyze a Steam capsule image using AI.
Parameters
- request: SteamCapsuleAnalysisRequest
  The analysis request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<SteamCapsuleAnalysisResponse>>
promise
- Defined in api/Media.ts:168

`Static` createLibraryLogo

createLibraryLogo(request, params?): AxiosPromise<default<CreateLibraryLogoResponse>>
Create a Steam Library Logo meeting Steam's requirements.
Parameters
- request: CreateLibraryLogoRequest
  The library logo creation request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<CreateLibraryLogoResponse>>
promise
- Defined in api/Media.ts:204

`Static` cropSteamCapsule

cropSteamCapsule(request, params?): AxiosPromise<default<SteamCapsuleCropResponse>>
Crop and resize an image to Steam capsule dimensions.
Parameters
- request: SteamCapsuleCropRequest
  The crop request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<SteamCapsuleCropResponse>>
promise
- Defined in api/Media.ts:156

`Static` get

get<T>(media_id, params?): AxiosPromise<default<T>>
Get media details.
Type Parameters
- T
Parameters
- media_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Media%20Route/getMedia
- Defined in api/Media.ts:144

`Static` getSteamCapsuleDimensions

getSteamCapsuleDimensions(capsuleType): null | SteamCapsuleDimensions
Get Steam capsule dimensions for a specific type.
Parameters
- capsuleType: string
  The type of Steam capsule.
Returns null | SteamCapsuleDimensions
The dimensions object or null if invalid type.
- Defined in api/Media.ts:227

`Static` getSteamCapsuleInfo

getSteamCapsuleInfo(capsuleType): any
Get Steam capsule type information and requirements.
Parameters
- capsuleType: string
  The type of Steam capsule.
Returns any
Information about the capsule type.
- Defined in api/Media.ts:249

`Static` getSteamLibraryLogoRequirements

getSteamLibraryLogoRequirements(): {
    content: string;
    format: string;
    maxHeight: number;
    maxWidth: number;
    requirement: string;
}
Get Steam library logo requirements.

Returns {
    content: string;
    format: string;
    maxHeight: number;
    maxWidth: number;
    requirement: string;
}
Library logo requirements object.
- content: string
- format: string
- maxHeight: number
- maxWidth: number
- requirement: string
- Defined in api/Media.ts:325

`Static` getSteamScreenshotRequirements

getSteamScreenshotRequirements(): {
    aspectRatio: number;
    content: string;
    format: string;
    minCount: number;
    minHeight: number;
    minWidth: number;
}
Get Steam screenshot requirements.

Returns {
    aspectRatio: number;
    content: string;
    format: string;
    minCount: number;
    minHeight: number;
    minWidth: number;
}
Screenshot requirements object.
- aspectRatio: number
- content: string
- format: string
- minCount: number
- minHeight: number
- minWidth: number
- Defined in api/Media.ts:309

`Static` removeBackground

removeBackground(request, params?): AxiosPromise<default<RemoveBackgroundResponse>>
Remove background from an image to create transparent PNG.
Parameters
- request: RemoveBackgroundRequest
  The background removal request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<RemoveBackgroundResponse>>
promise
- Defined in api/Media.ts:180

`Static` removeBackgroundAI

removeBackgroundAI(request, params?): AxiosPromise<default<RemoveBackgroundAIResponse>>
Remove background from an image using AI analysis for better results.
Parameters
- request: RemoveBackgroundAIRequest
  The AI-enhanced background removal request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<RemoveBackgroundAIResponse>>
promise
- Defined in api/Media.ts:192

`Static` uploadBlob

uploadBlob<T>(blob, data?, params?, onUploadProgress?): AxiosPromise<default<T>>
Upload media content using a Blob.
Type Parameters
- T
Parameters
- blob: Blob
  The Blob object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
- Optional onUploadProgress: ((progressEvent) => void)
  - - (progressEvent): void
    - Parameters
      progressEvent: AxiosProgressEvent
      Returns void
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Media%20Route/uploadMedia
- Defined in api/Media.ts:131

`Static` uploadFile

uploadFile<T>(file, data?, params?, onUploadProgress?): AxiosPromise<default<T>>
Upload media content using a File object.
Type Parameters
- T
Parameters
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
- Optional onUploadProgress: ((progressEvent) => void)
  - - (progressEvent): void
    - Parameters
      progressEvent: AxiosProgressEvent
      Returns void
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Media%20Route/uploadMedia
- Defined in api/Media.ts:117

`Static` validateScreenshot

validateScreenshot(request, params?): AxiosPromise<default<ScreenshotValidationResponse>>
Validate a screenshot against Steam's requirements.
Parameters
- request: ValidateScreenshotRequest
  The screenshot validation request parameters.
- Optional params: Record<string, any>
  Additional query parameters.
Returns AxiosPromise<default<ScreenshotValidationResponse>>
promise
- Defined in api/Media.ts:216

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static analyzeSteamCapsule

Parameters

request: SteamCapsuleAnalysisRequest

Optional params: Record<string, any>

Returns AxiosPromise<default<SteamCapsuleAnalysisResponse>>

Static createLibraryLogo

Parameters

request: CreateLibraryLogoRequest

Optional params: Record<string, any>

Returns AxiosPromise<default<CreateLibraryLogoResponse>>

Static cropSteamCapsule

Parameters

request: SteamCapsuleCropRequest

Optional params: Record<string, any>

Returns AxiosPromise<default<SteamCapsuleCropResponse>>

Static get

Type Parameters

T

Parameters

media_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static getSteamCapsuleDimensions

Parameters

capsuleType: string

Returns null | SteamCapsuleDimensions

Static getSteamCapsuleInfo

Parameters

capsuleType: string

Returns any

Static getSteamLibraryLogoRequirements

Returns { content: string; format: string; maxHeight: number; maxWidth: number; requirement: string; }

content: string

format: string

maxHeight: number

maxWidth: number

requirement: string

Static getSteamScreenshotRequirements

Returns { aspectRatio: number; content: string; format: string; minCount: number; minHeight: number; minWidth: number; }

aspectRatio: number

content: string

format: string

minCount: number

minHeight: number

minWidth: number

Static removeBackground

Parameters

request: RemoveBackgroundRequest

Optional params: Record<string, any>

Returns AxiosPromise<default<RemoveBackgroundResponse>>

Static removeBackgroundAI

Parameters

request: RemoveBackgroundAIRequest

Optional params: Record<string, any>

Returns AxiosPromise<default<RemoveBackgroundAIResponse>>

Static uploadBlob

Type Parameters

T

Parameters

blob: Blob

Optional data: object

Optional params: Record<string, any>

Optional onUploadProgress: ((progressEvent) => void)

Parameters

progressEvent: AxiosProgressEvent

Returns void

Returns AxiosPromise<default<T>>

See

Static uploadFile

Type Parameters

T

`Static` analyzeSteamCapsule

`Optional` params: Record<string, any>

`Static` createLibraryLogo

`Optional` params: Record<string, any>

`Static` cropSteamCapsule

`Optional` params: Record<string, any>

`Static` get

`Optional` params: Record<string, any>

`Static` getSteamCapsuleDimensions

`Static` getSteamCapsuleInfo

`Static` getSteamLibraryLogoRequirements

Returns {
content: string;
format: string;
maxHeight: number;
maxWidth: number;
requirement: string;
}

`Static` getSteamScreenshotRequirements

Returns {
aspectRatio: number;
content: string;
format: string;
minCount: number;
minHeight: number;
minWidth: number;
}

`Static` removeBackground

`Optional` params: Record<string, any>

`Static` removeBackgroundAI

`Optional` params: Record<string, any>

`Static` uploadBlob

`Optional` data: object

`Optional` params: Record<string, any>

`Optional` onUploadProgress: ((progressEvent) => void)

`Static` uploadFile

`Optional` data: object

`Optional` params: Record<string, any>

`Optional` onUploadProgress: ((progressEvent) => void)

`Static` validateScreenshot

`Optional` params: Record<string, any>