Studio Script Reference

Filter

Overview of all available scripting functionalities in Studio.

Check out Functions, Computed properties and Watchers to learn more about where and what to script.

Global context

General

• account
• bridge
• configuration
• connectivityState
• device
• functions
• getSource()
• params
• player
• packageConfiguration
• programs
• project
• sources
• timecode
• use()
• user
• utils
• setUser

Utils

• capitalize()
• ceil()
• convert()
• floor()
• gsap
• get()
• moment()
• padStart()
• parseInt()
• replace()
• round()
• set()
• sleep()
• startCase()
• toLower()
• toUpper()
• uuid()

Responses

• canRespond()
• canRespondCountdown()
• fetchResults()
• isFetchingResults()
• ownResponses()
• reset()
• resetResults()
• results()
• startFetchingResults()
• stopFetchingResults()
• submit()

Internals

• activeScene
• application
• definitions
• flatNodes
• nextTick()
• reactiveDelete()
• reactiveSet()
• stream

Scoped context

Event scope

• event

Function scope

• triggerContext

Actions

General

• callFunction()
• canvasDraw()
• cloudCapture()
• openDebugger()
• openUrl()
• passDataToComponent()
• playTimeline()
• setTimecodeSupport()
• subscribeToProgram()

Data

• loadData()
• postData()
• putData()
• deleteData()
• setData()
• resetData()
• resetResponses()
• submitResponse()
• getResponseResults()

Bridge

• sendBridgeMessage()
• sendBridgeMute()
• sendBridgeSpeed()
• sendBridgeState()
• sendBridgeTime()
• sendBridgeVideoScale()
• sendBridgeVolume()

Analytics

• trackUserEvent()

Lifecycle

• activate()
• deactivate()
• focusMove()
• hideScene()
• showScene()
• toggleActive()
• toggleScene()

Reorder

• zMoveAbove()
• zMoveBelow()
• zMoveToBottom()
• zMoveToIndex()
• zMoveToTop()

Timer

• resetTimer()
• startTimer()
• stopTimer()

Video

• muteVideo()
• pauseVideo()
• playVideo()
• seekVideo()
• videoSetVolume()

VAST

• vastMute()
• vastPause()
• vastPlay()
• vastSetVolume()
• vastSkip()

Player

• setPlayerControls()
• setPlayerState()
• setPlayerTime()

Sceenic

• sceenicConnect()
• sceenicCreateGroup()
• sceenicDisableAudio()
• sceenicDisableVideo()
• sceenicDisconnect()
• sceenicEnableAudio()
• sceenicEnableVideo()
• sceenicGroupChangeVolume()
• sceenicGroupMute()
• sceenicGroupPause()
• sceenicGroupPlay()
• sceenicGroupUnmute()
• sceenicSetGroupPosition()
• sceenicSetMediaQuality()
• sceenicStartSynchronize()
• sceenicStopSynchronize()
• sceenicToggleAudio()
• sceenicToggleVideo()

PlayFab

• playFabGetAdPlacements()
• playFabGetRequest()
• playFabLogin()
• playFabLogout()
• playFabPostRequest()
• playFabReportAdActivity()
• playFabRewardAdActivity()
• playFabSkipAdPlacement()
• playFabWritePlayerEvent()
• playFabWriteTitleEvent()
• playFabAnswerPrediction()
• playfabClaimPredictionRewards()