Open Go
Welcome to the API Documentation for the TODO link to Maven.
This document is strictly about library usage. For a high level overview and a demo app, see the OGP KMP SDK on Github.
The general procedure is:
Initialize the SDK
// App context is platform-specific context passed from application
val sdk = OgpSdk(Dispatchers.IO, appContext)Content copied to clipboardDiscover and connect to a GoPro Device. A successful connection will store it in the SDK's (runtime) database.
// Discover and take the first device we find
val device = sdk.discover(NetworkType.BLE).first()
// Connect (assume success)
val goproId = sdk.connect(device).getOrThrow()Content copied to clipboardNow that the device is connected and stored in the SDK, retrieve the GoPro object from the SDK. This can be done any number of times after connection.
// Now retrieve the gopro (assume success)
val gopro = sdk.getGoPro(goproId).getOrThrow()Content copied to clipboardManipulate the retrieved GoPro as desired
// Set the shutter
gopro.commands.setShutter(true)Content copied to clipboard
See the relevant packages below for more detailed information on specific objects.
Welcome to the API Documentation for the TODO link to Maven.
This document is strictly about library usage. For a high level overview and a demo app, see the OGP KMP SDK on Github.
The general procedure is:
Initialize the SDK
// App context is platform-specific context passed from application
val sdk = OgpSdk(Dispatchers.IO, appContext)Content copied to clipboardDiscover and connect to a GoPro Device. A successful connection will store it in the SDK's (runtime) database.
// Discover and take the first device we find
val device = sdk.discover(NetworkType.BLE).first()
// Connect (assume success)
val goproId = sdk.connect(device).getOrThrow()Content copied to clipboardNow that the device is connected and stored in the SDK, retrieve the GoPro object from the SDK. This can be done any number of times after connection.
// Now retrieve the gopro (assume success)
val gopro = sdk.getGoPro(goproId).getOrThrow()Content copied to clipboardManipulate the retrieved GoPro as desired
// Set the shutter
gopro.commands.setShutter(true)Content copied to clipboard
See the relevant packages below for more detailed information on specific objects.
Welcome to the API Documentation for the TODO link to Maven.
This document is strictly about library usage. For a high level overview and a demo app, see the OGP KMP SDK on Github.
The general procedure is:
Initialize the SDK
// App context is platform-specific context passed from application
val sdk = OgpSdk(Dispatchers.IO, appContext)Content copied to clipboardDiscover and connect to a GoPro Device. A successful connection will store it in the SDK's (runtime) database.
// Discover and take the first device we find
val device = sdk.discover(NetworkType.BLE).first()
// Connect (assume success)
val goproId = sdk.connect(device).getOrThrow()Content copied to clipboardNow that the device is connected and stored in the SDK, retrieve the GoPro object from the SDK. This can be done any number of times after connection.
// Now retrieve the gopro (assume success)
val gopro = sdk.getGoPro(goproId).getOrThrow()Content copied to clipboardManipulate the retrieved GoPro as desired
// Set the shutter
gopro.commands.setShutter(true)Content copied to clipboard
See the relevant packages below for more detailed information on specific objects.
Packages
This package contains components that relate to the connected GoPro including methods to operate on it.