Open GoPro SDK/com.gopro.open_gopro.gopro/CommandsContainer

CommandsContainer

class CommandsContainer

Wrapper to access operations exposed as methods.

Functions

deleteAllMedia

suspend fun deleteAllMedia(): Result<Unit>

Delete all media files on the SD card

deleteGroupedMedia

suspend fun deleteGroupedMedia(group: MediaId): Result<Unit>

Delete an entire group of media files such as in a burst, timelapse, or chaptered video.

deleteSingleMedia

suspend fun deleteSingleMedia(file: MediaId): Result<Unit>

Delete a single media file

downloadMedia

suspend fun downloadMedia(file: MediaId): Result<ByteArray>

Download a media file

getDateTime

suspend fun getDateTime(): Result<GpDatetime>

Get the camera's current date and time

getHardwareInfo

suspend fun getHardwareInfo(): Result<HardwareInfo>

Get hardware information of the connected camera

getLastCapturedMediaFileId

suspend fun getLastCapturedMediaFileId(): Result<MediaId>

Get the last captured media file ID

getLivestreamStatuses

suspend fun getLivestreamStatuses(): Result<Flow<LivestreamStatus>>

Get continuous livestream statuses

getMediaList

suspend fun getMediaList(): Result<MediaList>

Get the Media List

getMediaMetadata

suspend fun getMediaMetadata(file: MediaId): Result<MediaMetadata>

Get Media Metadata for a single media file

getPresetInfo

suspend fun getPresetInfo(): Result<Flow<PresetInfo>>

Get available presets and related preset information

getScreenNail

suspend fun getScreenNail(file: MediaId): Result<ByteArray>

Download a screennail for a given media file

getThumbNail

suspend fun getThumbNail(file: MediaId): Result<ByteArray>

Download a thumbnail for a given media file

getWebcamState

suspend fun getWebcamState(): Result<WebcamState>

Get the current webcam state

hilightFile

suspend fun hilightFile(file: MediaId, offsetMs: Int? = null): Result<Unit>

Add a hilight / tag to an existing photo or media file

hilightMoment

suspend fun hilightMoment(): Result<Unit>

Add hilight at current time while recording video

hilightRemove

suspend fun hilightRemove(file: MediaId, offsetMs: Int?): Result<Unit>

Remove an existing hilight from a photo or video file

loadPreset

suspend fun loadPreset(presetId: Int): Result<Unit>

Load a preset by ID

loadPresetGroup

suspend fun loadPresetGroup(group: PresetGroupId): Result<Unit>

Load a preset group by ID

readWifiPassword

suspend fun readWifiPassword(): Result<String>

Read the camera's Access Point password

readWifiSsid

suspend fun readWifiSsid(): Result<String>

Read the camera's Access Point SSID

setApMode

suspend fun setApMode(enable: Boolean): Result<Unit>

Set camera Access Point on / off

setDateTime

suspend fun setDateTime(datetime: LocalDateTime, utcOffset: UtcOffset, isDaylightSavings: Boolean): Result<Unit>

Set the camera's date and time.

setDigitalZoom

suspend fun setDigitalZoom(zoom: Int): Result<Unit>

Set the camera's digital zoom

setShutter

suspend fun setShutter(value: Boolean): Result<Unit>

Enable / disable the shutter to start / stop encoding

setThirdParty

suspend fun setThirdParty(): Result<Unit>

Flag as third party client

sleep

suspend fun sleep(): Result<Unit>

Put the camera to sleep

startLivestream

suspend fun startLivestream(request: LivestreamConfigurationRequest): Result<Unit>

Configure and start livestreaming

startPreviewStream

suspend fun startPreviewStream(): Result<Unit>

Start the preview stream

startWebcam

suspend fun startWebcam(resolution: WebcamResolution? = null, fov: WebcamFov? = null, port: Int? = null, protocol: WebcamProtocol? = null): Result<Unit>

Start wireless webcam streaming

stopPreviewStream

suspend fun stopPreviewStream(): Result<Unit>

Stop the preview stream

stopWebcam

suspend fun stopWebcam(): Result<Unit>

Stop the wireless webcam