Comment on page
Configuration
With Appetize's configuration options, users can easily switch between different device and operating system versions, languages, and many other options in order to customize their experience.
You can configure the client to change the device, OS version, app, and various other options. This will set the configuration for the embed before the session starts, either programmatically or by user interaction.
await client.setConfig({
device: 'iphone11pro',
osVersion: '15.0'
})
Additionally, you can provide these when starting a session programmatically:
const session = await client.startSession({
device: 'iphone11pro',
osVersion: '15.0'
})
stringThe publicKey of the Appetize app that you wish to run
stringstringThe operating system version on which to run your app. e.g. 11.4, 12.2, 13.3, 14.0
Note: We recommend leaving this blank so it will always use our latest default for the device
number | 'auto'Sets the scale of the device in the iframe.
If a number is provided it must be between 10 and 100. If
'auto', the device will scale up to fit inside the iframe."portrait" | "horizontal"Sets the orientation of the device
"vertical" | "horizontal" | "both"Centers the device within the embed
"black" | "white"Sets the color of the device chrome
booleanIf true, only show the screen and not the device chrome
stringstring(iOS only) Sets the locale of the device. Must be a locale ID e.g.
en_GB, fr_FRstringbooleanTurn on Auto-Correction for iOS. Defaults to
trueboolean(Android only) When true, disabled the onscreen keyboard
number[](iOS 12+, Android 10+) Sets location of the device in latitude and longitude. eg. [
39.903924,116.391432]stringboolean(Android only) Automatically grant all required app permissions
booleanWhen true, starts streaming the app on device load. Default is
falseWe recommend starting the session programmatically using
client.startSession() instead as this could cause the session to start before the SDK is ready.boolean(Android only) Hide password visibility when typing
stringSpecify a deep link to open when your app is launched
string[](iOS only) An array of strings to pass when launching your app
booleanWhen true, the session will listen for debug logs and emit them as a
log event.stringSpecify a proxy server to route network traffic. eg
http://example.com:8080For Appetize's built-in intercepting proxy, use
intercept. Network logs are emitted from the session as a network event.Our current support is limited to HTTP Proxies. When your app makes HTTPS connections, the data remains encrypted despite the unencrypted connection to the proxy. The app sends a CONNECT request to the proxy for the destination HTTPS server, initiating an SSL handshake. The proxy acts as a TCP connection forwarder, ensuring end-to-end encryption for app data.
booleanEnables recording of all user actions that took place during the session. See UI Automation for more information. Default is true.
boolean(Android only) Sets up an SSH tunnel to allow ADB connections to the emulator. SSH command and info can be found by accessing the adbConnection property on the session.
boolean(Android only) Allows installation of additional APKs after app launch
us | euEnsures that Appetize sessions are launched only from servers in a specific region.
It is best to avoid setting this property unless absolutely necessary. Our system automatically directs requests to the closest servers for optimal performance. Using this property could lead to longer queues in busy regions.
"dark" | "light"(iOS 13+ and Android 10+) Sets dark or light mode UI
objectA JSON object that will be passed to your app on launch
boolean(Android Only) Enables audio playback on the device
This feature is currently in Alpha and might not always work as expected.
"h264" | "jpeg"Set the video codec used for the stream. Default is
h264 if the browser supports it, otherwise falls back to jpeg.top | bottomAdjusts the position of Appetize toast messages used for displaying error or info messages. Default is
bottomLast modified 1mo ago