LiveCode

https://docs.livecode.com/
Admin
LiveCode is a comprehensive software development platform that allows users to create applications...
Tokens:130,053
Snippets:2,142
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Examples of start command usage

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/start

Demonstrates starting playback using a player name or a player index.

```LiveCode
start player "video"
```

```LiveCode
start player 1
```

--------------------------------

### Syntax for start command

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/start

The basic syntax for the start command requires a player reference.

```LiveCode
start <player>
```

--------------------------------

### Setting keyboardType Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/keyboardType

Examples demonstrating how to set a specific keyboard type or reset it to the default.

```LiveCode
set the keyboardType of field "cost" to "alphabet"
```

```LiveCode
set the keyboardType of field "name" to empty
```

--------------------------------

### Syntax and Usage Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/recordLoudness

Basic syntax and conditional usage examples for the recordLoudness function.

```LiveCode
the recordLoudness
```

```LiveCode
recordLoudness()
```

```LiveCode
if the recordLoudness is zero then pauseRecording
```

--------------------------------

### XBrowser_Focus Usage Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/XBrowser_Focus

Example showing the command being called with a browser instance identifier.

```LiveCode
XBrowser_Focus tBrowserId  
```

--------------------------------

### Set thumbPosition Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/thumbPosition

Examples demonstrating how to set the thumbPosition to a specific value or a calculated value based on the thumbSize.

```LiveCode
set the thumbPosition of scrollbar 1 to 400  
```

```LiveCode
set the thumbPosition of me to (3 * the thumbSize of me)  
```

--------------------------------

### Common Usage Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/put

Practical examples of using put for variables, fields, and network uploads.

```LiveCode
put "ABC"
```

```LiveCode
put 3 + 12 into myVariable
```

```LiveCode
put return & someGlobalVar after field "Accumulations"
```

```LiveCode
put tData into URL "ftp://ftp.myftpserver.com"
```

```LiveCode
put homegrownMP3Data into URL "binfile:My file.MP3"
```

--------------------------------

### ISOToMac Usage Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/ISOToMac

Basic usage examples demonstrating string conversion and character value mapping.

```LiveCode
ISOToMac("Ab4+")
```

```LiveCode
ISOToMac("")
```

```LiveCode
charToNum(ISOToMac(numToChar(myASCIIVal)))
```

--------------------------------

### httpdStart

Source: https://docs.livecode.com/tags/httpd-library

Initializes and starts the HTTP server.

```APIDOC
## httpdStart

### Description
Starts a HTTP server instance.
```

--------------------------------

### revRollBackDatabase Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/revRollBackDatabase

An example of using the revRollBackDatabase command with a database identifier.

```LiveCode
revRollBackDatabase monthlyExpenses
```

--------------------------------

### Adjust audio panning examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/audioPan

Examples demonstrating how to reset panning, shift audio to the left, and shift audio to the right.

```LiveCode
set the audioPan of player "myVideoPlayer" to 0 -- stereo channels unaffected
```

```LiveCode
set the audioPan of player "myVideoPlayer" to -50 -- 50% of the right channel audio moved to the left.
```

```LiveCode
set the audioPan of player "myVideoPlayer" to 100 -- 100% of the left channel audio moved to the right.
```

--------------------------------

### Simple repeat forever Loop

Source: https://docs.livecode.com/docs/LiveCode%20Script/Keywords/forever

A minimal example of starting a repeat forever loop.

```LiveCode
repeat forever  
```

--------------------------------

### remove command examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/remove

Examples demonstrating how to remove groups from cards using various references.

```LiveCode
remove group 1 from this card
```

```LiveCode
remove group "controls" from recent card
```

```LiveCode
remove group thisGroup from card "Overview"
```

--------------------------------

### RowLeftSwipeControlClicked Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Objects/Data%20Grid/Messages/RowLeftSwipeControlClicked

Examples demonstrating how to handle the message to perform actions like deleting a row or switching based on the target name.

```LiveCode
on RowLeftSwipeControlClicked  
   dispatch "DeleteIndex" to group "DataGrid" with the dgIndex of me  
end RowLeftSwipeControlClicked  
  
on RowLeftSwipeControlClicked pTarget  
   switch the name of the target  
      case "show"  
         dispatch "DeleteIndex" to group "DataGrid" with the dgIndex of me  
         break  
      case "archive"  
         dispatch "RowSwipeHideControl" to group "DataGrid"  
         break  
   end switch  
end RowLeftSwipeControlClicked  
```

--------------------------------

### Syntax and Usage Examples for mouseCharChunk

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/mouseCharChunk

These examples demonstrate the basic syntax and a conditional usage pattern for the mouseCharChunk function.

```LiveCode
the mouseCharChunk
```

```LiveCode
mouseCharChunk()
```

```LiveCode
if the mouseChar is empty then select the mouseCharChunk
```

--------------------------------

### Set printTitle Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/printTitle

Example of setting the printTitle property to a custom string.

```LiveCode
set the printTitle to "Accounts Report"
```

--------------------------------

### Set highlight state example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Button/Properties/highlight

Example demonstrating how to disable the highlight state for a specific button widget.

```LiveCode
set the highlight of widget "Power button" to false
```

--------------------------------

### Dictionary Array Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Operators/left-bracerightbrace

Various examples of dictionary array construction including empty arrays, mixed types, and nested structures.

```LiveCode
{}  
```

```LiveCode
{ "foo": 1, 1: "foo" }  
```

```LiveCode
{ "a": 1, 2: "b", "c": 3, 4: "d", }  
```

```LiveCode
{ "a": [], "b": [ {}, { "foo": 1 } ], 3: [[]] }  
```

```LiveCode
local tFirst, tSecond  
put { "foo": 1 } into tFirst  
put { 1: "foo" } into tSecond  
get { "a": tFirst, 2: tSecond }  
```

--------------------------------

### Basic Syntax Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/put

Standard syntax patterns for the put command.

```LiveCode
put <value> [{before | into | after} <container>]
```

```LiveCode
put <value> into URL <destinationURL>
```

--------------------------------

### Function Call Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/revXMLDataFromXPathQuery

A practical example of calling the function with a specific document ID and XPath string.

```livecode
put revXMLDataFromXPathQuery(2, "/bookstore/book/[price&lt;30]/title") into tBooks  
```

--------------------------------

### GetRightSwipeControl Implementation Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Objects/Data%20Grid/Messages/GetRightSwipeControl

These examples demonstrate how to return a specific control, conditionally hide the control based on row index, or disable the swipe functionality entirely.

```LiveCode
on GetRightSwipeControl  
   return group "my custom right swipe control"  
end GetRightSwipeControl
```

```LiveCode
on GetRightSwipeControl  
   -- Hide for the data grid row number 5  
   if the dgIndex of me is 5 then  
      return empty  
   end if  
   pass GetRightSwipeControl  
end GetRightSwipeControl
```

```LiveCode
on GetRightSwipeControl  
   -- Turn left drags and swipes off  
   return empty  
end GetRightSwipeControl
```

--------------------------------

### Sample Deployment Settings

Source: https://docs.livecode.com/guides/Platform/Testing%20and%20Publishing/Deployment%20Walkthrough

Example configuration object representing the required metadata for an application deployment.

```json
"appName": "My Responsive App",    
"version": "1.0.0",    
"platforms": ["Web", "Desktop"]  
```

--------------------------------

### Set vScroll Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/vScroll

Example of setting the vertical scroll position of a group to 20 pixels.

```LiveCode
set the vScroll of group "Thumbnails" to 20  
```

--------------------------------

### Compact stack examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/compact

Demonstrates how to compact the current stack or a specific stack by name.

```LiveCode
compact this stack
```

```LiveCode
compact stack "Project 1"
```

--------------------------------

### Set iconColor Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Tree%20View/Properties/iconColor

Example of setting the icon color of a Tree View widget to red using an RGB string.

```LiveCode
set the iconColor of widget "Tree View" to "250,0,0"
```

--------------------------------

### Hide taskbar with backdrop

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/hide%20taskbar

Example showing the command used in conjunction with setting a backdrop.

```LiveCode
    hide taskbar  
    set the backdrop to "red" -- or whatever you want  
```

--------------------------------

### Custom Script Block Example

Source: https://docs.livecode.com/guides/Platform/Adding%20Logic/Actions/Actions%20Overview

A basic example of a Raw LiveCode Script Block used within the Workflow Editor to handle a mouse click event.

```LiveCode
on mouseUp    
 answer "Button Clicked!"    
end mouseUp  
```

--------------------------------

### Live URL Example

Source: https://docs.livecode.com/guides/Platform/Testing%20and%20Publishing/Deployment%20Walkthrough

The format of the URL generated upon successful deployment to the web.

```text
https://myapp.livecodecreate.io/your-app-name  
```

--------------------------------

### Set stack decorations with multiple options

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/decorations

Example of setting multiple window decorations at once.

```LiveCode
set the decorations of stack "Test" to  
    "metal,title,close,minimize,maximize"
```

--------------------------------

### AddNumberTo Usage Example

Source: https://docs.livecode.com/docs/LiveCode%20Builder/Statements/AddNumberTo

Demonstrates initializing a variable and incrementing its value.

```LiveCode
    variable tVar as Number  
    put 2 into tVar  
    add 10 to tVar -- tVar contains 12
```

--------------------------------

### asin Usage Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/asin

Common usage patterns for the asin function.

```LiveCode
the asin of .225
```

```LiveCode
sin(asin(.5))
```

```LiveCode
asin(pi/4 - sin(myAngle))
```

--------------------------------

### Example Property Operations

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties

Common operations for retrieving or copying properties between objects.

```LiveCode
put the properties of button 1 into myArray
```

```LiveCode
set the properties of last player to the properties of player "Example"
```

--------------------------------

### Syntax and Usage Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/mouseChunk

Basic syntax and usage patterns for the mouseChunk function.

```LiveCode
the mouseChunk
```

```LiveCode
mouseChunk()
```

```LiveCode
the mouseChunk
```

```LiveCode
if the shiftKey is down then select the mouseChunk
```

--------------------------------

### Retrieve formattedLeft values

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/formattedLeft

Examples showing how to get the formattedLeft property for a card and a specific text chunk.

```LiveCode
get the formattedLeft of this card
put the formattedLeft of the clickChunk into clickedHeight
```

--------------------------------

### Example of an after mouseUp handler

Source: https://docs.livecode.com/docs/LiveCode%20Script/Control%20Structures/after

A simple implementation of an after handler that triggers on a mouseUp event.

```LiveCode
after mouseUp  
  answer "after mouse up received"  
end mouseUp
```

--------------------------------

### catch usage example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Keywords/catch

Shows the basic implementation of the catch keyword with an error parameter.

```LiveCode
catch myError
```

--------------------------------

### Handling Connections with Callbacks

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/accept

Demonstrates setting up a listener and defining the handler to process the incoming connection IP address.

```LiveCode
on mouseUp
   accept connections on port 80 with message "connectionMade"
end mouseUp

on connectionMade pIPAddress
   put "Connection made:" && pIPAddress
end connectionMade
```

--------------------------------

### start <player>

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/start

Resumes playing a paused movie or sound in the specified player.

```APIDOC
## start <player>

### Description
Resumes playing a paused movie or sound in a player. The playback begins at the player's current currentTime property.

### Syntax
start <player>

### Parameters
- **player** (reference) - Required - A reference to the player object to be started.

### Examples
```
start player "video"
start player 1
```
```

--------------------------------

### Set verticalTextAlign example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Android%20Native%20Field/Properties/verticalTextAlign

Example of setting the vertical alignment of an Android field widget to middle.

```LiveCode
set the verticalTextAlign of widget "Android Field" to "middle"  
```

--------------------------------

### Retrieve XML attributes

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/revXMLAttributes

Examples demonstrating the usage of revXMLAttributes with different delimiters.

```LiveCode
revXMLAttributes(3,"/Continents",": ",return)
```

```LiveCode
put revXMLAttributes(myTree,thisNode," - ",";") into field "Attr"
```

```LiveCode
repeat for each line thisLine in revXMLAttributes(1,"/",tab,return)
```

--------------------------------

### Handle newWidget message

Source: https://docs.livecode.com/docs/LiveCode%20Script/Messages/newWidget

Use this handler to perform setup tasks like setting tooltips for newly created widgets.

```LiveCode
on newWidget -- set tooltips of new widgets  
    set the tooltip of the target to the kind of the target  
end newWidget
```

--------------------------------

### Set and Get printColors Property

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/printColors

Syntax for configuring and querying the printColors property.

```LiveCode
set the printColors to {true | false}
```

```LiveCode
get the printColors
```

--------------------------------

### File and Resource URL Operations

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/put

Examples demonstrating file system and resource fork operations using URLs.

```LiveCode
    local tResult  
    put tData into url (file: tFilePath)  
    if tResult is not empty then  
        # Handle error here  
    else  
        # Continue execution  
    end if
```

```LiveCode
    put URL resfile:My Source into URL resfile:Destination
```

```LiveCode
    put empty into URL file:filePath
```

--------------------------------

### Apply colorOverlay to an Object

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/colorOverlay

Examples of applying a color overlay to a button or the current object.

```LiveCode
set the colorOverlay of button "Ok" to tOverlayPropertiesArray
```

```LiveCode
set the colorOverlay["color"] of me to "255,0,0"
```

--------------------------------

### Example Output Format

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/revXMLDataFromXPathQuery

Shows the default output format where items are returned one per line when delimiters are not specified.

```text
    J. K. Rowling  
    Harry Potter  
    Cory Doctorow  
    Little Brother  
```

--------------------------------

### Set scaleBackColor Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Radial%20Slider/Properties/scaleBackColor

Example of setting the background color of a specific radial slider widget to a semi-transparent yellow.

```LiveCode
set the scaleBackColor of widget "Radial Slider" to "255,255,0,158"
```

--------------------------------

### Get enableToolTip Syntax

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Chart/Properties/enableToolTip

Syntax for retrieving the current state of the enableToolTip property.

```LiveCode
get the enableToolTip of widget
```

--------------------------------

### Conditionals and Loops

Source: https://docs.livecode.com/guides/Platform/Adding%20Logic/Script%20Writing

Example of using a repeat loop to populate a field with multiple lines of data.

```LiveCode
repeat with i = 1 to 5    
 put "Item " & i into line i of field "ListField"    
end repeat  
```

--------------------------------

### Retrieve camera capabilities

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/mobileCameraFeatures

Use these examples to query the features of a specific camera or the default camera configuration.

```LiveCode
put mobileCameraFeatures(tCamera) into tFeatures
```

```LiveCode
put mobileCameraFeatures("rear") into tFeatures
```

--------------------------------

### Create a media query

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/mergMPQueryCreate

Initializes a new media query and returns a memory pointer.

```LiveCode
mergMPQueryCreate()
```

--------------------------------

### Using Variables

Source: https://docs.livecode.com/guides/Platform/Adding%20Logic/Script%20Writing

Demonstrates declaring a local variable and displaying its content.

```LiveCode
local tName    
put "John Doe" into tName    
answer "Hello, " & tName  
```

--------------------------------

### Example: Enable PolyGrid Header

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/PolyGrid/Properties/showHeader

Sets the showHeader property to true for a specific PolyGrid widget instance.

```LiveCode
set the showHeader of widget"PolyGrid" to true
```

--------------------------------

### Set and Get printTitle Syntax

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/printTitle

Syntax for setting and retrieving the printTitle property.

```LiveCode
set the printTitle to <string>
```

```LiveCode
get the printTitle
```

--------------------------------

### Custom Workflow Script

Source: https://docs.livecode.com/guides/Platform/Adding%20Logic/Script%20Writing

Example of combining navigation and user interaction within a workflow.

```LiveCode
go to layout "Dashboard"    
answer "Welcome to the Dashboard!"  
```

--------------------------------

### mergScreenGetBrightness

Source: https://docs.livecode.com/tags/function

Get the brightness of the screen.

```APIDOC
## mergScreenGetBrightness

### Description
Get the brightness of the screen.
```

--------------------------------

### mergNICInterfaces

Source: https://docs.livecode.com/tags/function

Get the network interfaces.

```APIDOC
## mergNICInterfaces

### Description
Get the network interfaces.
```

--------------------------------

### Configure and Display an Android Browser

Source: https://docs.livecode.com/docs/LiveCode%20Script/Objects/AndroidBrowser

Creates a browser instance, stores its ID, sets its visibility, and navigates to a specific URL.

```LiveCode
mobileControlCreate "browser", "web view"
put the result into sBrowserID
mobileControlSet sBrowserID, "visible", "true"
mobileControlSet sBrowserID, "url", "http://www.livecode.com"
```

--------------------------------

### mergMPQueryCollectionTitle

Source: https://docs.livecode.com/tags/function

Get the title of the collection.

```APIDOC
## mergMPQueryCollectionTitle

### Description
Get the title of the collection.
```

--------------------------------

### Navigate to a stack

Source: https://docs.livecode.com/docs/LiveCode%20Script/Objects/stack

Use the go command to display a specific stack by name.

```LiveCode
go to stack "Help"
```

--------------------------------

### mergButtonGet

Source: https://docs.livecode.com/tags/function

Get a button property.

```APIDOC
## mergButtonGet

### Description
Get a button property.
```

--------------------------------

### Execute FTP Commands

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/libURLftpCommand

Examples of sending specific FTP commands to servers with varying authentication and port configurations.

```LiveCode
put libURLftpCommand("PWD","ftp.example.org") into field "Directory"  
```

```LiveCode
get libURLftpCommand("SITE HELP","example.net:75","root",field "password")  
```

--------------------------------

### mergAVPlayerGet

Source: https://docs.livecode.com/tags/function

Get a player property.

```APIDOC
## mergAVPlayerGet

### Description
Get a player property.
```

--------------------------------

### dropboxGetThumbnail

Source: https://docs.livecode.com/tags/command

Get a thumbnail for an image.

```APIDOC
## dropboxGetThumbnail

### Description
Get a thumbnail for an image.
```

--------------------------------

### qrCreate

Source: https://docs.livecode.com/tags/qr-library

Initializes and creates a new QR code.

```APIDOC
## qrCreate

### Description
Creates a new QR code instance.

### Usage
`qrCreate()`
```

--------------------------------

### dropboxGetPreview

Source: https://docs.livecode.com/tags/command

Get a preview for a file.

```APIDOC
## dropboxGetPreview

### Description
Get a preview for a file.
```

--------------------------------

### productVersion

Source: https://docs.livecode.com/tags/function

Returns the version of LiveCode Create currently running.

```APIDOC
## productVersion

### Description
Returns the version of LiveCode Create currently running.
```

--------------------------------

### AWSS3GetBucket

Source: https://docs.livecode.com/docs/LiveCode%20Script/Libraries/Amazon%20Web%20Services

Get a bucket description.

```APIDOC
## AWSS3GetBucket

### Description
Get a bucket description.

### Syntax
AWSS3GetBucket <pBucket>,<pParameters>,<pCallback>
```

--------------------------------

### dropboxListFolder

Source: https://docs.livecode.com/tags/command

Starts returning the contents of a folder.

```APIDOC
## dropboxListFolder

### Description
Starts returning the contents of a folder.
```

--------------------------------

### Updating an animation example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Libraries/LiveCode%20Motion/Commands/updateAnimation

Demonstrates how to define keyframes and apply them to an animation named 'slide' with a duration of 2 seconds and an easing function.

```LiveCode
local tKeyframes  
put "left:0;top:0" into tKeyframes["0"]  
put "left:100;top:100" into tKeyframes["100"]  
updateAnimation "slide", tKeyframes, 2, "inOutQuad"
```

--------------------------------

### mediaFoundationWriterBeginWriting Syntax

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/mediaFoundationWriterBeginWriting

The command requires a file path string as an argument to begin the writing process.

```LiveCode
mediaFoundationWriterBeginWriting <pFilePath>
```

--------------------------------

### revBrowserOpen

Source: https://docs.livecode.com/tags/function

Opens and initialises a new browser.

```APIDOC
## revBrowserOpen

### Description
Opens and initialises a new browser.
```

--------------------------------

### androidStartAudioPlayingInBackground

Source: https://docs.livecode.com/tags/androidbgaudio-library

Starts playing audio in the background.

```APIDOC
## androidStartAudioPlayingInBackground

### Description
Start playing audio in the background.
```

--------------------------------

### mergSettingsGetValueForKey

Source: https://docs.livecode.com/tags/function

Gets the setting for the specified key.

```APIDOC
## mergSettingsGetValueForKey

### Description
Gets the setting for the specified key.
```

--------------------------------

### GetOpt

Source: https://docs.livecode.com/tags/function

Parse options from command line arguments.

```APIDOC
## GetOpt

### Description
Parse options from command line arguments.
```

--------------------------------

### mergNICMacAddress

Source: https://docs.livecode.com/tags/function

Get the MAC address for an interface.

```APIDOC
## mergNICMacAddress

### Description
Get the MAC address for an interface.
```

--------------------------------

### mergNICIPInfo

Source: https://docs.livecode.com/tags/function

Get a property of an interface IP.

```APIDOC
## mergNICIPInfo

### Description
Get a property of an interface IP.
```

--------------------------------

### StartActivityForResult

Source: https://docs.livecode.com/tags/androidutils-library

Initiates an activity using an Intent.

```APIDOC
## StartActivityForResult

### Description
Starts an Android activity using the provided Intent.
```

--------------------------------

### mergNICIPCount

Source: https://docs.livecode.com/tags/function

Get the number of IPs for an interface.

```APIDOC
## mergNICIPCount

### Description
Get the number of IPs for an interface.
```

--------------------------------

### mergAVAssetGet

Source: https://docs.livecode.com/tags/function

Get the value of an asset property.

```APIDOC
## mergAVAssetGet

### Description
Get the value of an asset property.
```

--------------------------------

### mediaFoundationReaderDuration

Source: https://docs.livecode.com/tags/function

Get the duration of the media file.

```APIDOC
## mediaFoundationReaderDuration

### Description
Get the duration of the media file.

### Platform
desktop
```

--------------------------------

### mediaFoundationMediaTypeGetAttribute

Source: https://docs.livecode.com/tags/function

Get an attribute of a media type.

```APIDOC
## mediaFoundationMediaTypeGetAttribute

### Description
Get an attribute of a media type.

### Platform
desktop
```

--------------------------------

### AWSS3GetObject

Source: https://docs.livecode.com/docs/LiveCode%20Script/Libraries/Amazon%20Web%20Services

Get an object from an S3 bucket.

```APIDOC
## AWSS3GetObject

### Description
Get an object.

### Syntax
AWSS3GetObject <pBucket>,<pObject>,<pParameters>,<pFile>,<pCallback>
```

--------------------------------

### AWSS3GetService

Source: https://docs.livecode.com/docs/LiveCode%20Script/Libraries/Amazon%20Web%20Services

Get the S3 service description.

```APIDOC
## AWSS3GetService

### Description
Get the S3 service description.

### Syntax
AWSS3GetService <pCallback>
```

--------------------------------

### mobileStorePurchasedProducts

Source: https://docs.livecode.com/tags/function

Get the list of all known completed purchases.

```APIDOC
## mobileStorePurchasedProducts

### Description
Get the list of all known completed purchases.
```

--------------------------------

### accept

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/accept

The accept command initializes a server listener on a specified port. It supports both standard TCP connections and UDP datagrams, returning the bound port in the 'it' variable and error information in 'the result'.

```APIDOC
## accept [datagram] connections on port <portNumber> with message <callbackMessage>

### Description
Accepts an internet connection or UDP datagram and creates a socket for communication. When a connection is established or a datagram is received, the specified callbackMessage is sent to the object.

### Syntax
`accept [datagram] connections on port <portNumber> with message <callbackMessage>`

### Parameters
- **datagram** (optional) - If specified, the command accepts UDP datagrams instead of TCP connections.
- **portNumber** (integer) - The port number to listen on. Use 0 to allow the OS to assign an ephemeral port.
- **callbackMessage** (string) - The name of the message to trigger upon connection or receipt. The message receives the sender's IP address as the first parameter, and the datagram content as the second parameter (if applicable).

### Return Values
- **it** - The actual port number bound by the system.
- **the result** - Contains an error message if the socket could not be opened.
```

--------------------------------

### mergMPQueryCollectionItemCount

Source: https://docs.livecode.com/tags/function

Get the number of items in the media collection.

```APIDOC
## mergMPQueryCollectionItemCount

### Description
Get the number of items in the media collection.
```

--------------------------------

### mergAVCamGet

Source: https://docs.livecode.com/tags/function

Get the current property of the camera control.

```APIDOC
## mergAVCamGet

### Description
Get the current property of the camera control.
```

--------------------------------

### mergAVCamBarcodeTypes

Source: https://docs.livecode.com/tags/function

Get a list of possible barcode types.

```APIDOC
## mergAVCamBarcodeTypes

### Description
Get a list of possible barcode types.
```

--------------------------------

### mergAVAssetTrackGet

Source: https://docs.livecode.com/tags/function

Get the value of an asset track property.

```APIDOC
## mergAVAssetTrackGet

### Description
Get the value of an asset track property.
```

--------------------------------

### Set joinStyle Property

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/joinStyle

Examples demonstrating how to apply different join styles to graphic objects.

```LiveCode
set the joinstyle of graphic 1 of card "myCard" to "bevel"
```

```LiveCode
set the joinstyle of the selectedobject to "round"
```

--------------------------------

### Set toolTip Examples

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/toolTip

Various ways to assign tooltip text to controls, including static strings, field content, and multiline strings.

```LiveCode
set the toolTip of button "OK" to "Click to accept the result"  
```

```LiveCode
set the toolTip of me to field "Explanation"  
```

```LiveCode
set the toolTip of me to "Hello" & return & "World!"  
```

--------------------------------

### mediaFoundationVideoProcessorGetOutputMediaType

Source: https://docs.livecode.com/tags/function

Get the current output media type.

```APIDOC
## mediaFoundationVideoProcessorGetOutputMediaType

### Description
Get the current output media type.

### Platform
desktop
```

--------------------------------

### mediaFoundationReaderNumberOfStreams

Source: https://docs.livecode.com/tags/function

Get the number of streams in the media file.

```APIDOC
## mediaFoundationReaderNumberOfStreams

### Description
Get the number of streams in the media file.

### Platform
desktop
```

--------------------------------

### XPath Query Usage

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/revXMLDataFromXPathQuery

Demonstrates how to define an XPath expression and retrieve the corresponding data.

```livecode
    put "/bookstore/book/[price&lt;30]/title" into pXPathExpression  
    put revXMLDataFromXPathQuery(pDocID, pXPathExpression)  
```

--------------------------------

### dropboxGetSharedLinkMetadata

Source: https://docs.livecode.com/tags/command

Get the shared link's metadata.

```APIDOC
## dropboxGetSharedLinkMetadata

### Description
Get the shared link's metadata.
```

--------------------------------

### Basic asin Syntax

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/asin

Standard syntax variations for calculating the arc sine.

```LiveCode
the asin of <number>
```

```LiveCode
asin(<number>)
```

--------------------------------

### dropboxGetAccountBatch

Source: https://docs.livecode.com/tags/command

Get information about multiple user accounts.

```APIDOC
## dropboxGetAccountBatch

### Description
Get information about multiple user accounts. At most 300 accounts may be queried per request.
```

--------------------------------

### dropboxGetAccount

Source: https://docs.livecode.com/tags/command

Get information about a user's account.

```APIDOC
## dropboxGetAccount

### Description
Get information about a user's account.
```

--------------------------------

### Handling browserLoadRequest

Source: https://docs.livecode.com/docs/LiveCode%20Script/Messages/browserLoadRequest

An example handler that prompts the user to confirm a URL load request before passing the message.

```LiveCode
on browserLoadRequest pURL, pType  
   answer "Do you want to load:" && pURL with "Yes" and "No"  
   if it is "Yes" then  
      pass browserLoadRequest  
   else  
      put "Refused:" && pURL into field "Status"  
   end if  
end browserLoadRequest
```

--------------------------------

### fontNames

Source: https://docs.livecode.com/tags/function

Returns a list of the currently installed fonts.

```APIDOC
## fontNames

### Description
Returns a list of the currently installed fonts.
```

--------------------------------

### revBrowserOpenCef

Source: https://docs.livecode.com/tags/function

Opens and initialises a new Chrome-based browser.

```APIDOC
## revBrowserOpenCef

### Description
Opens and initialises a new Chrome-based browser.
```

--------------------------------

### Locking the Cursor

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/lockCursor

Example of setting the lockCursor property to true.

```LiveCode
set the lockCursor to true
```

--------------------------------

### Create and show a mobile input control

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/mobileControlSet

Demonstrates creating a new input control and immediately setting its visibility property to true.

```LiveCode
mobileControlCreate "input", "nameInput"  
mobileControlSet "nameInput", "visible", true  
```

--------------------------------

### Initialize and measure a string variable

Source: https://docs.livecode.com/docs/LiveCode%20Builder/Expressions/EmptyString

Demonstrates initializing a string variable using the empty string expression and verifying its length.

```LiveCode Builder
variable tVar as String  
variable tCount as Number  
put the empty string into tVar  
put the number of chars in tVar into tCount -- tCount is 0  
```

--------------------------------

### ticks

Source: https://docs.livecode.com/tags/function

Returns the number of ticks since the start of the eon.

```APIDOC
## ticks

### Description
Returns the number of ticks since the start of the eon.
```

--------------------------------

### target

Source: https://docs.livecode.com/tags/function

Returns the object which received the message that started execution.

```APIDOC
## target

### Description
Returns the object which received the message that started execution.
```

--------------------------------

### Configure Deployment Settings in LiveCode

Source: https://docs.livecode.com/guides/Platform/Testing%20and%20Publishing/Preparing%20Your%20App%20for%20Publishing

Use these commands to programmatically set the application name, icon, and target platform for your project deployment.

```LiveCode
set the appName of project to "My To-Do App"    
set the appIcon of project to "icon-512.png"    
set the deploymentPlatform of project to "web"  
```

--------------------------------

### revXMLRootNode

Source: https://docs.livecode.com/tags/function

Returns the path to the starting node of an XML tree.

```APIDOC
## revXMLRootNode

### Description
Returns the path to the starting node of an XML tree.
```

--------------------------------

### milliseconds

Source: https://docs.livecode.com/tags/function

Returns the number of milliseconds since the start of the eon.

```APIDOC
## milliseconds

### Description
Returns the number of milliseconds since the start of the eon.
```

--------------------------------

### Edit video with mergAVEditVideo

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/mergAVEditVideo

Examples showing how to call the function with different quality and duration parameters.

```LiveCode
put mergAVEditVideo(tVideoPath,"medium",180) into tEditedVideoPath  
put mergAVEditVideo(tVideoPath,"low") into tEditedVideoPath
```

--------------------------------

### mobileStorePurchaseError

Source: https://docs.livecode.com/tags/function

Get more detailed information about errors in the purchase request.

```APIDOC
## mobileStorePurchaseError

### Description
Get more detailed information about errors in the purchase request.
```

--------------------------------

### platform

Source: https://docs.livecode.com/tags/function

Returns the name of the operating system LiveCode is running on.

```APIDOC
## platform

### Description
Returns the name of the operating system LiveCode is running on.
```

--------------------------------

### Typical HTTP Headers List

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/libURLSetCustomHTTPHeaders

An example of a multi-line string representing a typical HTTP headers list.

```text
    GET /catsdata/coldat.dat HTTP/1.1  
Connection:Close  
    User-Agent: My Fancy Browser  
Host:www.cats-training.com  
Accept:image/gif, image/x-xbitmap, image/jpeg, image/png, */*  
    Accept-Encoding: gzip  
    Accept-Charset: iso-8859-1,*,utf-8  
```

--------------------------------

### mergBLEPeripheralServiceAdvertisementData

Source: https://docs.livecode.com/tags/function

Get the advertisement data for a service from a peripheral discovery.

```APIDOC
## mergBLEPeripheralServiceAdvertisementData

### Description
Get the advertisement data for a service from a peripheral discovery.
```

--------------------------------

### mergAVAssetExportSessionPresets

Source: https://docs.livecode.com/tags/function

Get a list of asset export session presets.

```APIDOC
## mergAVAssetExportSessionPresets

### Description
Get a list of asset export session presets.
```

--------------------------------

### Set Custom HTTP Headers

Source: https://docs.livecode.com/docs/LiveCode%20Script/Commands/libURLSetCustomHTTPHeaders

Examples of setting custom HTTP headers using a string literal or a field reference.

```livecode
libURLSetCustomHTTPHeaders "GET /catsdata/coldat.dat HTTP/1.1"  
```

```livecode
libURLSetCustomHTTPHeaders field "Headers"  
```

--------------------------------

### Retrieve FTP Server Information

Source: https://docs.livecode.com/docs/LiveCode%20Script/Functions/libURLftpCommand

Displays general information about an FTP server by issuing the HELP command.

```LiveCode
    answer libURLftpCommand("HELP",ftp.example.net)  
```

--------------------------------

### mediaFoundationReaderStreamGetCurrentMediaType

Source: https://docs.livecode.com/tags/function

Get the current media type of a reader stream.

```APIDOC
## mediaFoundationReaderStreamGetCurrentMediaType

### Description
Get the current media type of a reader stream.

### Platform
desktop
```

--------------------------------

### dropboxListFolderGetLatestCursor

Source: https://docs.livecode.com/tags/command

A way to get a cursor for the folder's state.

```APIDOC
## dropboxListFolderGetLatestCursor

### Description
A way to get a cursor for the folder's state.
```

--------------------------------

### Syntax for highlight property

Source: https://docs.livecode.com/docs/LiveCode%20Script/Widgets/Button/Properties/highlight

Use these commands to set or retrieve the current highlight state of a widget.

```LiveCode
set the highlight of widget to {true | false}
```

```LiveCode
get the highlight of widget
```

--------------------------------

### dropboxGetCurrentAccount

Source: https://docs.livecode.com/tags/command

Get information about the current user's account.

```APIDOC
## dropboxGetCurrentAccount

### Description
Get information about the current user's account.
```

--------------------------------

### AWSS3GetPresignedURL

Source: https://docs.livecode.com/docs/LiveCode%20Script/Libraries/Amazon%20Web%20Services

Get a pre-signed URL that is valid for a period of time.

```APIDOC
## AWSS3GetPresignedURL

### Description
Get a pre-signed url that is valid for a perod of time.

### Syntax
AWSS3GetPresignedURL(<pBucket>,<pObject>,<pExpires>)
```

--------------------------------

### Equivalent cursor settings

Source: https://docs.livecode.com/docs/LiveCode%20Script/Constants/busy

Demonstrates that setting the cursor to busy is equivalent to setting it to the integer 6.

```LiveCode
    set the cursor to busy  
    set the cursor to 6  
```

--------------------------------

### Set yExtent Example

Source: https://docs.livecode.com/docs/LiveCode%20Script/Properties/yExtent

Sets the height of an EPS object named myEPS to 288 points, which corresponds to 4 inches.

```LiveCode
set the yExtent of EPS myEPS to 288 -- 4 inches
```

--------------------------------

### mergAVCompositionCreate

Source: https://docs.livecode.com/tags/function

Create a composition.

```APIDOC
## mergAVCompositionCreate

### Description
Create a composition.
```
Tokens:
Raw