amazon-ivs-player
Advanced tools
amazon-ivs-player - npm Package Compare versions
Comparing version 1.8.0 to 1.10.0
@@ -1,3 +0,1 @@ | ||
| import { AutoPlayOptions } from 'types/autoplay-options'; | ||
| /** | ||
@@ -38,2 +36,3 @@ * Contains ad metadata from the stream. | ||
| vlm: boolean; | ||
| type: 'AdCue'; | ||
| } | ||
@@ -133,26 +132,27 @@ | ||
| export declare class MediaPlayer implements Player { | ||
| addEventListener<K extends keyof PlayerEventMap>(name: K, fn: (payload: PlayerEventMap[K]) => void): void; | ||
| attachHTMLVideoElement(videoElement: HTMLVideoElement): void; | ||
| delete(): void; | ||
| isAutoplay(): boolean; | ||
| isAutoQualityMode(): boolean; | ||
| getBufferDuration(): number; | ||
| getBuffered(): BufferRange; | ||
| getDisplayHeight(): number; | ||
| getDisplayWidth(): number; | ||
| getDuration(): number; | ||
| getHTMLVideoElement(): HTMLVideoElement; | ||
| getLiveLatency(): number; | ||
| getPlaybackRate(): number; | ||
@@ -162,18 +162,18 @@ getPosition(): number; | ||
| getQuality(): Quality; | ||
| getSessionId(): string | undefined; | ||
| getState(): PlayerState; | ||
| getVersion(): string; | ||
| getVolume(): number; | ||
| isLiveLowLatency(): boolean; | ||
| isMuted(): boolean; | ||
| isPaused(): boolean; | ||
| load(path: string, mediaType?: string): void; | ||
@@ -184,32 +184,32 @@ pause(): void; | ||
| seekTo(time: number): void; | ||
| setAutoMaxQuality(quality: Quality): void; | ||
| setAutoMaxBitrate(bitrate: number): void; | ||
| setAutoMaxVideoSize(width: number, height: number): void; | ||
| setAutoplay(enabled: boolean): void; | ||
| setAutoQualityMode(enable: boolean): void; | ||
| setInitialBufferDuration(duration: number): void; | ||
| setLiveLowLatencyEnabled(enable: boolean): void; | ||
| setLogLevel(level: LogLevel): void; | ||
| setMuted(mute: boolean): void; | ||
| setPlaybackRate(rate: number): void; | ||
| setQuality(quality: Quality, adaptive?: boolean): void; | ||
| setRebufferToLive(enable: boolean): void; | ||
| setVolume(volume: number): void; | ||
| setRequestCredentials(credentials: RequestCredentials): void; | ||
| } | ||
@@ -306,8 +306,8 @@ | ||
| delete(): void; | ||
| /** | ||
@@ -318,5 +318,5 @@ * Gets the version of the player. | ||
| getVersion(): string; | ||
| /** | ||
@@ -361,3 +361,3 @@ * Loads the specified stream and prepares the player for playback. On success, the player state changes to | ||
| seekTo(time: number): void; | ||
| /** | ||
@@ -409,2 +409,3 @@ * Gets whether the player is muted. | ||
| * If a value outside the allowable range is used, the current value is maintained. | ||
| * Defaults to 1s in low latency mode, 2s otherwise. | ||
| * Lowering this value may increase rebuffering. | ||
@@ -427,3 +428,3 @@ * | ||
| setAutoplay(enabled: boolean): void; | ||
| /** | ||
@@ -439,4 +440,4 @@ * Gets the playback rate. | ||
| setPlaybackRate(rate: number): void; | ||
| /** | ||
@@ -454,4 +455,4 @@ * Gets the state of the player. | ||
| getPosition(): number; | ||
| /** | ||
@@ -462,4 +463,4 @@ * Gets the duration of the currently loaded media stream. | ||
| getDuration(): number; | ||
| /** | ||
@@ -479,4 +480,4 @@ * Enables skipping to the live edge on a rebuffer. Note this can cause video content | ||
| setRequestCredentials(credentials: RequestCredentials): void; | ||
| /** | ||
@@ -490,3 +491,3 @@ * Gets the ID of the playback session. | ||
| getSessionId(): string | undefined; | ||
| /** | ||
@@ -506,14 +507,20 @@ * Gets whether the Adaptive Bitrate (ABR) streaming algorithm is enabled. The maximum quality is controlled by | ||
| setAutoQualityMode(enable: boolean): void; | ||
| /** | ||
| * Sets the maximum quality the player is allowed to auto-switch up to (if ABR is enabled). This allows you to | ||
| * control resource usage. The {@link Quality} you provide here is applied to the current stream. If you | ||
| * load a new stream, call this again after {@link PlayerState.READY}. | ||
| * Sets the maximum quality the player is allowed to auto-switch up to (if ABR is enabled) using the input | ||
| * quality's bitrate value. This allows you to control resource usage. The {@link Quality} you provide here | ||
| * is applied to the current stream. If you load a new stream, call this again after {@link PlayerState.READY}. | ||
| * @param quality - The maximum quality to use for ABR. | ||
| */ | ||
| setAutoMaxQuality(quality: Quality): void; | ||
| /** | ||
| * Sets the maximum video display size of the player. This prevents the player from auto-switching to qualities | ||
| * above the specified resolution when ABR is enabled. | ||
| * @param width - The display width. | ||
| * @param height - The display height. | ||
| */ | ||
| setAutoMaxVideoSize(width: number, height: number): void; | ||
| /** | ||
| * For a live stream, returns the latency from the server to the player. Note: For non-live streams, this value is not meaningful. | ||
@@ -534,3 +541,3 @@ * @returns the latency in seconds. | ||
| setLiveLowLatencyEnabled(enable: boolean): void; | ||
| /** | ||
@@ -546,3 +553,4 @@ * Sets the log level for the player. | ||
| getBuffered(): BufferRange; | ||
| /** | ||
@@ -553,10 +561,10 @@ * Gets the buffer length ahead of the current playback position. | ||
| getBufferDuration(): number; | ||
| /** | ||
@@ -572,3 +580,3 @@ * Gets the `clientHeight` of the underyling HTMLMediaElement. | ||
| getDisplayWidth(): number; | ||
| } | ||
@@ -591,3 +599,3 @@ | ||
| wasmBinary: string; | ||
| /** | ||
@@ -598,7 +606,8 @@ * @deprecated | ||
| logLevel?: LogLevel; | ||
| } | ||
@@ -734,4 +743,4 @@ | ||
| ERROR = "PlayerError", | ||
| /** | ||
@@ -758,6 +767,6 @@ * Indicates that the player position changed. | ||
| SEEK_COMPLETED = "PlayerSeekCompleted", | ||
| /** | ||
@@ -775,4 +784,4 @@ * Indicates that a text cue was parsed from the stream. | ||
| TEXT_METADATA_CUE = "PlayerTextMetadataCue", | ||
| /** | ||
@@ -784,3 +793,3 @@ * Indicates that a playback unavailable event occurred. | ||
| NETWORK_UNAVAILABLE = "PlayerNetworkUnavailable", | ||
| } | ||
@@ -792,4 +801,4 @@ | ||
| declare interface PlayerEventTypeMap { | ||
| [PlayerEventType.AUDIO_BLOCKED]: void; | ||
@@ -800,3 +809,3 @@ [PlayerEventType.BUFFER_UPDATE]: void; | ||
| [PlayerEventType.INITIALIZED]: void; | ||
| [PlayerEventType.MUTED_CHANGED]: void; | ||
@@ -808,7 +817,7 @@ [PlayerEventType.NETWORK_UNAVAILABLE]: void; | ||
| [PlayerEventType.REBUFFERING]: void; | ||
| [PlayerEventType.SEEK_COMPLETED]: number; | ||
| [PlayerEventType.STATE_CHANGED]: PlayerState; | ||
| [PlayerEventType.TEXT_CUE]: TextCue; | ||
@@ -818,4 +827,4 @@ [PlayerEventType.TEXT_METADATA_CUE]: TextMetadataCue; | ||
| [PlayerEventType.VOLUME_CHANGED]: number; | ||
| } | ||
@@ -882,3 +891,3 @@ | ||
| name: string; | ||
| /** The codec string, both audio and video tracks. For example, "avc1.64002A,mp4a.40.2". */ | ||
@@ -892,4 +901,4 @@ codecs: string; | ||
| height: number; | ||
| } | ||
@@ -961,2 +970,3 @@ | ||
| streamSource: string; | ||
| type: 'StreamSourceCue'; | ||
| } | ||
@@ -980,2 +990,3 @@ | ||
| text: string; | ||
| type: 'TextCue'; | ||
| } | ||
@@ -994,2 +1005,3 @@ | ||
| owner: string; | ||
| type: 'TextMetadataCue'; | ||
| } | ||
@@ -996,0 +1008,0 @@ |
@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard. | ||
| "packageName": "@microsoft/api-extractor", | ||
| "packageVersion": "7.7.10" | ||
| "packageVersion": "7.22.2" | ||
| } | ||
| ] | ||
| } |
| { | ||
| "name": "amazon-ivs-player", | ||
| "version": "1.8.0", | ||
| "version": "1.10.0", | ||
| "description": "Amazon IVS Player Web SDK", | ||
@@ -37,3 +37,3 @@ "homepage": "https://aws.amazon.com/ivs/", | ||
| "devDependencies": { | ||
| "@microsoft/api-extractor": "^7.7.10", | ||
| "@microsoft/api-extractor": "^7.22.2", | ||
| "typedoc": "^0.18.0" | ||
@@ -40,0 +40,0 @@ }, |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.02%
3034672
- Lines of code
- increased by1.18%
942