Introduction
"Autoscroll behavior" is a Collection property exclusive to ordered collections that specifies whether a collection should move automatically from one item to the next using predefined parameters.
Properties
"Autoscroll behavior" has the following properties:
-
Delay after scene entry: Number of seconds to wait after scene entry before autoscrolling should begin
- Delay after interaction: Number of seconds to wait after a user manipulates the collection before restarting autoscroll
-
Item display duration: Number of seconds to display an item in the collection before autoscrolling to the next item.
- Can be overridden for individual items. Select any individual item in the collection and, in the "Autoscroll behavior" section of the Properties panel, deselect the "Use collection display duration" property and specify a "Display duration" (measured in seconds).
- Can be overridden for individual items. Select any individual item in the collection and, in the "Autoscroll behavior" section of the Properties panel, deselect the "Use collection display duration" property and specify a "Display duration" (measured in seconds).
- Behavior at end: Specify what should happen when the last item is reached in the collection. Options are "Reverse direction", "Jump to start", and "Stop".
- Autoplay item in focus: Specify whether or not each item in a collection should be permitted to play in its entirety before autoscrolling. If turned on, this property overrides the "Item display duration" property. Applies to the Video Asset, YouTube Asset, Audio Asset and - exclusive to experiences on all platforms but Windows - the Document Asset.
Differences between Player technologies
Ordered collections have a set of autoscroll triggers, and the events that raise those triggers can differ between Player on Windows and Player on all other supported platforms.
|
Trigger |
Event |
Trigger raised in Player on Windows? |
Trigger raised in Player on all other platforms? |
|---|---|---|---|
|
Autoscroll is activated |
at initialization |
YES |
YES |
|
if "Autoscroll" property is turned on |
YES |
YES |
|
|
when the collection becomes visible |
YES |
YES |
|
|
when the "Start autoscroll" action is called |
YES |
YES |
|
|
when the number of items in the collection changes from 0 to N |
NO |
YES |
|
|
when restarting autoscroll after reaching the end of collection (due to "Behavior at end" property) |
NO |
YES |
|
|
Autoscroll is deactivated |
if "Autoscroll" property is turned off |
YES |
YES |
|
when the collection becomes hidden |
YES |
YES |
|
|
when the "Stop autoscroll" action is called |
YES |
YES |
|
|
when the number of items goes from N to 0 |
NO |
YES | |
|
when autoscroll stops after reaching the end of the collection (due to "Behavior at end" property) |
NO |
YES |
|
|
Autoscrolling is paused |
when user activity is detected |
YES Could be raised multiple times |
YES Will only be raised the first time |
|
when the collection becomes visible |
YES |
YES |
|
|
when the number of items goes from N to 0 |
NO |
NO |
|
|
when the number of items goes from 0 to N |
YES |
YES |
|
|
when filtering Excel |
NO If the current item in focus is affected, the timer is restarted using the new item's display duration |
NO If the current item in focus is affected, the timer is restarted using the new item's display duration |
|
|
when refreshing / updating a data source accessed through a web request (REST Interface Asset) |
YES Could be raised multiple times |
NO If the current item in focus is affected, the timer is restarted using the new item's display duration |
|
|
when filtering a Headless CMS base |
YES Will be raised multiple times if clearing multiple filters at the same time, or applying multiple filters |
NO If the current item in focus is affected, the timer is restarted using the new item's display duration |
|
|
when a collection navigation action is called (e.g. Previous, Next, Go to…) |
YES Starts a timer using item display duration, not delay after interaction |
NO | |
|
when updating the index in focus through binding |
NO |
NO |
|
|
Is autoscrolled |
when autoscroll begins the first scroll |
YES |
YES |
|
|
when autoscroll moves to the next item |
NO |
NO |
Collection differences for Player
- Asset Grids
- Player on Windows
Asset Grids are comprised of multiple rows or columns. Autoscroll will advance the Asset Grid by one row or column.
Player will consider item display duration as the max duration for all visible items in the viewport. Composer does not show the “Item duration override” property for individual items placed inside the Asset Grid, but this option can be set by switching (back and forth) to another type of collection supporting it. - Player on all other platforms
Asset Grids are comprised of multiple rows or columns. Autoscroll will advance the Asset Grid by replacing all visible rows/columns with new rows/columns.
Player will consider item display duration as the max duration for all visible items in the viewport. Composer does not show the “Item duration override” property for individual items placed inside the Asset Grid, but this option can be set by switching (back and forth) to another type of collection supporting it.
- Player on Windows
- All nested collections (i.e. collections inside collections)
-
Player on Windows
Nested collections are not linked to the parent collection and will start autoscrolling as soon as they become visible, whether or not they are in focus. -
Player on all other platforms
Nested collections are considered playable items and will start autoscrolling only when they are in focus.
-
-
Autoplay
-
Player on Windows
Media with their "Autoplay" property enabled will start to play as soon as they become visible in a collection, whether or not the collection's Autscroll property "Autoplay item in focus" is enabled. -
Player on all other platforms
-
If a collection's Autscroll property "Autoplay item in focus" is enabled:
Media with their "Autoplay" property enabled will start to play only when in focus in the collection. - If the Autscroll property "Autoplay item in focus" is disabled:
Media with their "Autoplay" property enabled will start to play as soon as they become visible in the collection.
-
-
- Other Autoscroll behaviors
-
Player on Windows
-
Autoscroll will play the media in focus when first starting. If the media is paused, it will start at the beginning.
-
Item display duration & delay: If an item's display duration is greater than the autoscroll delay, the delay will be used for displaying the first item.
-
Playable media: If a user manually plays a media asset, autoscroll will not wait for the media to end before restarting.
-
-
Player on all other platforms
-
Autoscroll will play media in focus when first starting. If the media is paused, it will start from the current position.
-
Item display duration & delay: If an item's display duration is greater than the autoscroll delay, the item display duration will be used for displaying the first item.
-
Playable media: If a user manually plays a media asset, autoscroll will wait for the media to end before restarting.
-
-
Comments
0 comments
Please sign in to leave a comment.