Helper Functions
Functions
Function Name Parameters Return Data Type Description
scale (Number Input,Number InputMin,Number InputMax,Number OutputMin,Number OutputMax,Boolean ClipToOutputRange(optional)) Number Scales the value < Input> according to the ratio between and . Restricts the output to the stated output range if ClipToOutputRange is True
mediaIndex (Number Bank,Number Clip) Number Converts a and to a media index
mediaClip (Number MediaIndex) Number Returns the Clip portion of a media index
mediaBank (Number MediaIndex) Number Returns the Bank portion of a media index
time (Number Hours,Number Minutes,Number Seconds,Number Milliseconds(optional)) Number Returns and as total milliseconds
timecode24 (Number Hours,Number Minutes,Number Seconds,Number Frames) Number Returns a value that represents the entered timecode as total milliseconds based on a timecode format of 23.98 fps
timecode25 (Number Hours,Number Minutes,Number Seconds,Number Frames) Number Returns a value that represents the entered timecode as total milliseconds based on a timecode format of 25 fps
timecode30NonDrop (Number Hours,Number Minutes,Number Seconds,Number Frames) Number Returns a value that represents the entered timecode as total milliseconds based on a timecode format of 30.00 fps Non Drop
timecode30Drop (Number Hours,Number Minutes,Number Seconds,Number Frames) Number Returns a value that represents the entered timecode as total milliseconds based on a timecode format of 29.97 fps Drop Frame
sleep (Number Milliseconds) Nothing Forces the script execution to pause for Milliseconds
regexMatch (String Input,String Pattern,Boolean IgnoreCase(optional)) Boolean Returns True if the string < Input> matches the regex pattern , false if it does not match
regexReplace (String Input,String Replacement,String Pattern) String Returns a new String where the string < Input> is modified with string according to the regex string
ping (String IP,Number TimeOut) Boolean Returns true if a response is received to a network ping to address before the timeout of Milliseconds
udpSend (String Data,String IP,Number Port,String LocalIP(optional)) Boolean Attempts to send the String using UDP to target IP on port using the local network adapter with IP Address . Returns true if data was sent to target, false if there was an error
tcpSend (String Data,String IP,Number Port,String LocalIP(optional),Number TimeOut(optional)) Attempts to send the String using TCP to target IP on port using the local network adapter with IP Address . Returns true if data was sent to target within Milliseconds, false if there was an error or it took too long
httpGet (String Address) String Performs an Http Get request to address
and returns the message received back as a string
httpPost (String Address,String Data String Performs an Http Post request to address
including the added data and returns the message received back as a string

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
Green Hippo Forum

Post Comment