Class AdsRenderingSettings

AI-generated Key Takeaways

• AdsRenderingSettings defines parameters controlling the rendering of ads.

• Key properties include controlling non-linear ad positioning with autoAlign, setting the maximum recommended bitrate with bitrate, and enabling preloading of video assets with enablePreloading.

• Other properties allow setting a timeout for video ad media file loading with loadVideoTimeout, specifying supported MIME types with mimeTypes, and controlling ad playback based on time for VMAP and ad rules with playAdsAfterTime.

• Additional settings include restoring the video element state after ad breaks with restoreCustomPlaybackStateOnAdBreakComplete, displaying specific IMA UI elements with uiElements, and styling linear and non-linear ads with useStyledLinearAds and useStyledNonLinearAds.

Note: This reference page follows TypeScript documentation structure. If you have suggestions for or see issues with the reference documentation, open a thread with your feedback on the IMA technical forum.

---

Extends AdsRenderingSettingsInterface

Defines parameters that control the rendering of ads.

Constructors
constructor	Constructor.

Properties
autoAlign	Set to false if you want to have fine grained control over the positioning of all non-linear ads. Inherited from AdsRenderingSettingsInterface.autoAlign
bitrate	Maximum recommended bitrate. Inherited from AdsRenderingSettingsInterface.bitrate
enablePreloading	Enables preloading of video assets. Inherited from AdsRenderingSettingsInterface.enablePreloading
loadVideoTimeout	Timeout (in milliseconds) when loading a video ad media file. Inherited from AdsRenderingSettingsInterface.loadVideoTimeout
mimeTypes	Only supported for linear video mime types. Inherited from AdsRenderingSettingsInterface.mimeTypes
playAdsAfterTime	For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds). Inherited from AdsRenderingSettingsInterface.playAdsAfterTime
restoreCustomPlaybackStateOnAdBreakComplete	Specifies whether the SDK should record the state of the provided video element before it is used for ads, and restore the state after the ads have completed. Inherited from AdsRenderingSettingsInterface.restoreCustomPlaybackStateOnAdBreakComplete
uiElements	Specifies whether to display specific IMA UI elements. Inherited from AdsRenderingSettingsInterface.uiElements
useStyledLinearAds	Render linear ads with full UI styling. Inherited from AdsRenderingSettingsInterface.useStyledLinearAds
useStyledNonLinearAds	Render non-linear ads with a close and recall button. Inherited from AdsRenderingSettingsInterface.useStyledNonLinearAds

Constructors

---

constructor

new AdsRenderingSettings(): AdsRenderingSettings

Constructor.

Returns
AdsRenderingSettings

Properties

---

autoAlign

autoAlign: boolean

Set to false if you want to have fine grained control over the positioning of all non-linear ads. If this value is true, the ad is positioned in the bottom center. If this value is false, the ad is positioned in the top left corner. The default value is true.

---

bitrate

bitrate: number

Maximum recommended bitrate. The value is in kbit/s. The SDK will pick media with bitrate below the specified max, or the closest bitrate if there is no media with lower bitrate found. Default value, -1, means the SDK selects the maximum bitrate.

---

enablePreloading

enablePreloading: boolean

Enables preloading of video assets. For more info see our guide to preloading media.

---

loadVideoTimeout

loadVideoTimeout: number

Timeout (in milliseconds) when loading a video ad media file. If loading takes longer than this timeout, the ad playback is canceled and the next ad in the pod plays, if available. Use -1 for the default of 8 seconds.

---

mimeTypes

mimeTypes: string[]

Only supported for linear video mime types. If specified, the SDK will include media that matches the MIME type(s) specified in the list and exclude media that does not match the specified MIME type(s). The format is a list of strings, for example, [ 'video/mp4', 'video/webm', ... ] If not specified, the SDK will pick the media based on player capabilities.

---

playAdsAfterTime

playAdsAfterTime: number

For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds). This setting is strictly after - for example, setting playAdsAfterTime to 15 will cause IMA to ignore an ad break scheduled to play at 15s.

---

restoreCustomPlaybackStateOnAdBreakComplete

restoreCustomPlaybackStateOnAdBreakComplete: boolean

Specifies whether the SDK should record the state of the provided video element before it is used for ads, and restore the state after the ads have completed. This is only relevant for custom playback, when the same video element is used for both ads and content. The default value is false.

---

uiElements

uiElements: string[]

Specifies whether to display specific IMA UI elements. For more details, see UiElements. AdSense and AdX ads render their own ad UI regardless of this setting.

---

useStyledLinearAds

useStyledLinearAds: boolean

Render linear ads with full UI styling. This setting does not apply to AdSense/AdX ads or ads played in a mobile context that already use full UI styling by default.

---

useStyledNonLinearAds

useStyledNonLinearAds: boolean

Render non-linear ads with a close and recall button.