aosplayer 0.2.8 | Documentation

aosplayer

0.2.8

broadcastAOSEvent
fullscreenGallery
exitFullscreenGallery
getGalleryComponent
TagFactory ▸
- Instance members
- #tagsBelongingTo
tagview
hideToolTip
Library ▸
- Instance members
- #vehicle
getVehicle
Vehicle ▸
- Static members
- .getPoster
- .getVideoPlaylist
fullscreenPanorama
exitFullscreenPanorama
getPanoramaComponent
fullscreenSpinner
exitFullscreenSpinner
getSpinnerComponent
fullscreenVideo
exitFullscreenVideo
getVideoComponent

Need help reading this?

broadcastAOSEvent

Broadcast AOS Event

broadcastAOSEvent(detail: object)

Parameters

detail (object)

fullscreenGallery

Full Screen AOS Gallery

fullscreenGallery(playerDiv: String)

Parameters

playerDiv

(String
            = '')

exitFullscreenGallery

Exit Full Screen AOS Gallery

exitFullscreenGallery(playerDiv: String)

Parameters

playerDiv

(String
            = '')

getGalleryComponent

Get Gallery Componenet Element

getGalleryComponent(element: Element): Element

Parameters

element (Element)

Returns

Element:

TagFactory

Factory for creating Tags

new TagFactory(tags: Array)

Parameters

tags (Array)

Instance Members

▸ tagsBelongingTo(parentMedia)

Returns all tags belonging to the parent media

tagsBelongingTo(parentMedia: String): Array

Parameters

parentMedia (String)

Returns

Array: all tag objects belonging to the given parent media

tagview

Class for displaying tags visually

tagview(div: String, tags: Array, interactive: Boolean, shouldFocus: Boolean)

Parameters

div (String) element name to inject

tags (Array) to add to the view

interactive

(Boolean
            = true)

whether the view is interactive

shouldFocus

(Boolean
            = false)

whether the tag should cause a focus on the parent image

hideToolTip

function to hide tooltip if mobile device change its orientation

hideToolTip()

Library

SDK for AutosOnShow Vehicle Assets

new Library(apiKey: String)

Parameters

apiKey (String) AOS Access Key

Instance Members

▸ vehicle(identifier)

vehicle(identifier: String): Promise

Parameters

identifier (String) ID of the AOS vehicle

Returns

Promise: promise for the vehicle request

getVehicle

Return a vehicle from AOS containing all assets

getVehicle(identifier: String, authToken: String, buildType: any): Promise

Parameters

identifier (String) Vehicle Identifier (AOS)

authToken (String) Authentication Token for the Request

buildType

(any
            = 'PLAYER')

Returns

Promise: promise Promise contaiting the resulting vehicle

Vehicle

Represents a Vehicle and its asset pack

new Vehicle()

Static Members

▸ getPoster()

Poster images sit above video assets until the video plays

getPoster(): any

Returns

any:

▸ getVideoPlaylist()

Video Playlists are ordered sequences of all included video files

getVideoPlaylist(): any

Returns

any:

Instance Members

▸ getTitle()

Get the Vehicle Title

getTitle(): String

Returns

String: Vehicle title

▸ getDescription()

Get the Vehicle Description

getDescription(): String

Returns

String: Vehicle description

▸ getThumbnail()

Get the Vehicle Thumbnail image

getThumbnail(): String

Returns

String: Vehicle thumbnail URL

▸ getThumbnailLarge()

Get the Vehicle Thumbnail (Large)

getThumbnailLarge(): String

Returns

String: Vehicle thumbnail URL

▸ getThumbnailPlay()

Get the Vehicle Video Play Button

getThumbnailPlay(): String

Returns

String: Vehicle Play button URL

▸ getLibraryId()

Get the Vehicle Libraryu Id

getLibraryId(): String

Returns

String: Vehicle Library ID

▸ getDateCreated()

Get the Vehicle Date of creation

getDateCreated(): String

Returns

String: Vehicle creation date

▸ getDateModified()

Get the Vehicle last modified date

getDateModified(): String

Returns

String: Vehicle modified date

▸ getImages()

Get the Vehicle images

getImages(): Array

Returns

Array: Vehicle images

▸ getSmallImages()

Get the Vehicle Images

getSmallImages(): Array

Returns

Array: Vehicle images (small only)

▸ getMediumImages()

Get the Vehicle Images

getMediumImages(): Array

Returns

Array: Vehicle images (medium only)

▸ getLargeImages()

Get the Vehicle Images

getLargeImages(): Array

Returns

Array: Vehicle images (large only)

▸ hasImages()

Returns whether this vehicle has imagees

hasImages(): Boolean

Returns

Boolean: Vehicle has linked images

▸ getInternalPanorama()

Get the Vehicle Panorama image

getInternalPanorama(): String

Returns

String: URL to the panoramae

▸ hasInternalPanorama()

Returns whether this vehicle has a panorama

hasInternalPanorama(): Boolean

Returns

Boolean: Vehicle HAS IMAGES

▸ getVideo()

Get the Vehicle video URL

getVideo(): String

Returns

String: Vehicle video URL

▸ hasVideo()

Returns whether this vehicle has a video

hasVideo(): Boolean

Returns

Boolean: Vehicle has video

▸ getThreeSixtyImages()

Get the Vehicle Images for the external spinner

getThreeSixtyImages(): Array

Returns

Array: Image sequence

▸ hasThreeSixtyImages()

/** Returns whether this vehicle has external three sixty images

hasThreeSixtyImages(): Boolean

Returns

Boolean: Vehicle has 360

▸ getExplodedThreeSixtyImages()

Get the Vehicle Images for the exploded external spinner

getExplodedThreeSixtyImages(): Array

Returns

Array: Image sequence

▸ hasThreeExplodedSixtyImages()

/** Returns whether this vehicle has exploded external three sixty images

hasThreeExplodedSixtyImages(): Boolean

Returns

Boolean: Vehicle has 360

▸ getAllThreeSixtyImages()

Returns regular AND exploded 360 in a sequence

getAllThreeSixtyImages(): Boolean

Returns

Boolean: Vehicle has 360

▸ hasPoster()

Get the Vehicle Poster URL

hasPoster(): String

Returns

String: Vehicle Poster image URL

▸ getTags()

Get the Vehicle Tags

getTags(): Array

Returns

Array: Vehicle tags

▸ hasTags()

Returns whether this vehicle has tags

hasTags(): Boolean

Returns

Boolean: Vehicle HAS tags

▸ getTopVideo()

Get the Vehicle Top Video URL

getTopVideo(): String

Returns

String: Vehicle video URL for top video

▸ getTailVideo()

Get the Vehicle Tail Video URL

getTailVideo(): String

Returns

String: Vehicle video URL for tail video

▸ hasTopVideo()

Returns whether this vehicle has a top video

hasTopVideo(): Boolean

Returns

Boolean: Vehicle a top video

▸ hasTailVideo()

Returns whether this vehicle has a tail video

hasTailVideo(): Boolean

Returns

Boolean: Vehicle a tail video

▸ hasVideoPlaylist()

Returns whether this vehicle has a video playlist

hasVideoPlaylist(): Array

Returns

Array: Playlist URLs

▸ getVideoOptions()

Get the Video Title

getVideoOptions(): Object

Returns

Object: Vehicle Options

▸ getGalleryOptions()

Get the Gallery Title

getGalleryOptions(): Object

Returns

Object: Gallery Options

▸ getPanoramaOptions()

Get the Panorama Options

getPanoramaOptions(): Object

Returns

Object: Panorama Options

▸ getSpinnerOptions()

Get the Spinner Options

getSpinnerOptions(): Object

Returns

Object: Spinner Options

▸ getStartComponent()

Get the Starting Component

getStartComponent(): String

Returns

String: Start component ID

▸ getAnalyticsSettings()

Get the Analytics Settings

getAnalyticsSettings(): Object

Returns

Object: Analytics configuration

▸ hasAnalytics()

Returns whether analytics are enabled

hasAnalytics(): Boolean

Returns

Boolean: Analytics enabled

▸ hasPersonalVideoRequest()

Returns whether Personal Video can be requested

hasPersonalVideoRequest(): Boolean

Returns

Boolean: Personal video allowed

▸ getPersonalVideoForm()

Returns the personal video form (if it exists)

getPersonalVideoForm(): Object

Returns

Object: Personal Video form

▸ isPersonalVideo()

Returns whether this vehicle is a video created based on a personal video request

isPersonalVideo(): Boolean

Returns

Boolean: is a Personal Video

▸ getAOSAuthToken()

Get the AOS Auth Token

getAOSAuthToken(): String

Returns

String: Auth Token

▸ isValidUrl(url)

Check Url is valida or not

isValidUrl(url: String): Boolean

Parameters

url (String)

Returns

Boolean:

▸ getOverview()

Generates an overview of the Vehicle

getOverview()

fullscreenPanorama

Full Screen AOS Panorama

fullscreenPanorama(playerDiv: String)

Parameters

playerDiv

(String
            = '')

exitFullscreenPanorama

Exit Full Screen AOS Panorama

exitFullscreenPanorama(playerDiv: String)

Parameters

playerDiv

(String
            = '')

getPanoramaComponent

Get Panorama Componenet Element

getPanoramaComponent(element: Element): Element

Parameters

element (Element)

Returns

Element:

fullscreenSpinner

Full Screen AOS Spinner

fullscreenSpinner(playerDiv: String)

Parameters

playerDiv

(String
            = '')

exitFullscreenSpinner

Exit Full Screen AOS Spinner

exitFullscreenSpinner(playerDiv: String)

Parameters

playerDiv

(String
            = '')

getSpinnerComponent

Get Spinner Componenet Element

getSpinnerComponent(element: Element): Element

Parameters

element (Element)

Returns

Element:

fullscreenVideo

Full Screen AOS Video

fullscreenVideo(playerDiv: String)

Parameters

playerDiv

(String
            = '')

exitFullscreenVideo

Exit Full Screen AOS Gallery

exitFullscreenVideo(playerDiv: String)

Parameters

playerDiv

(String
            = '')

getVideoComponent

Get Video Componenet Element

getVideoComponent(element: Element): Element

Parameters

element (Element)

Returns

Element: