liveURL
Returns a fully-qualified, user-shareable live-URL for streaming the web-browser to an end-user, optionally interactive.
Set 30 second timer for interaction
mutation LiveURL {
goto(url: "https://example.com") {
status
}
liveURL {
liveURL
}
}
Maintain the current browsers viewport and don't resize it
mutation LiveURL {
goto(url: "https://example.com") {
status
}
liveURL(resizable: false) {
liveURL
}
}
Don't allow interaction at all
mutation LiveURL {
goto(url: "https://example.com") {
status
}
liveURL(interactable: false) {
liveURL
}
}
Low quality for better bandwidth
mutation LiveURL {
goto(url: "https://example.com") {
status
}
liveURL(quality: 20 type: jpeg) {
liveURL
}
}
liveURL(
timeout: Float
interactable: Boolean = true
type: LiveURLStreamType = jpeg
quality: Int = 100
resizable: Boolean = true
): LiveURLResponse
Arguments
liveURL.timeout
● Float
scalar
The maximum time allowed for the browser to remain alive. Once the time is reached, the end-user will receive a prompt that the session has closed
liveURL.interactable
● Boolean
scalar
Whether the session is interactable or not. Set to "false" to not allow click and mouse events to be forwarded through to the end-user
liveURL.type
● LiveURLStreamType
enum
The binary-type of the streamed imaged. "jpeg" will consumer lower bandwidth and useful low bandwidth networks and devices. "png" is a much higher quality but will consume considerably more bandwidth.
Use "jpeg" when setting a custom quality
liveURL.quality
● Int
scalar
The quality of the stream, represented as number from 1 - 100. Only used when "type" is "jpeg"
liveURL.resizable
● Boolean
scalar
Whether or not to resize the underlying browser to match the end-user's screen size. When false
the underlying browser will retain it's current viewport, and the end users's screen wil maintain the appropriate aspect ratio.
Type
LiveURLResponse
object
The response from the Live-URL query