FastPix Android Data Core SDK

Key Features:

Requirements

Installation

Gradle (Kotlin DSL)

dependencyResolutionManagement {
 repositories {
 google()
 mavenCentral()
 maven {
 url = uri("https://maven.pkg.github.com/FastPix/android-core-data-sdk")
 credentials {
 username = project.findProperty("lpr.user") as String? ?: "github-username"
 password =
 project.findProperty("lpr.token") as String? ?: "github-personal-access-token"
 }
 }
 }
}

dependencies {
 implementation("io.fastpix.data:core:1.2.6")
}

Authentication

lpr.user=YOUR_GITHUB_USERNAME
lpr.key=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN

Quick Start

1. Initialize the SDK

import io.fastpix.data.FastPixDataSDK
import io.fastpix.data.domain.SDKConfiguration
import io.fastpix.data.domain.model.VideoDataDetails
import io.fastpix.data.domain.model.PlayerDataDetails
import io.fastpix.data.domain.model.CustomDataDetails
import io.fastpix.data.domain.listeners.PlayerListener
class MainActivity : AppCompatActivity() {
 private val fastPixSDK = FastPixDataSDK()
 override fun onCreate(savedInstanceState: Bundle?) {
 super.onCreate(savedInstanceState)
 // Create configuration
 val config = SDKConfiguration(
 workspaceId = "your-workspace-id",
 beaconUrl = "custom.beacon.url", // Optional
 // Optional
 videoData = VideoDataDetails(
 videoId = "video-123",
 videoTitle = "My Awesome Video",
 videoDuration = "300000", // in milliseconds
 videoThumbnail = "https://example.com/thumbnail.jpg",
 fpPlaybackId = "playback-id" // Optional FastPix playback ID
 //.. etc
 ),
 // Optional
 playerData = PlayerDataDetails(
 playerName = "ExoPlayer",
 playerVersion = "2.19.0"
 ),
 playerListener = MyPlayerListener(),
 enableLogging = true, // Enable for debugging
 // Optional
 customData = CustomDataDetails(
 customField1 = "custom-value-1",
 customField2 = "custom-value-2"
 //.. etc
 )
 )
 // Initialize SDK
 fastPixSDK.initialize(config, applicationContext)
 }
 
 override fun onDestroy() {
 super.onDestroy()
 // Clear the SDK instance
 fastPixSDK.release()
 }
}

2. Implement PlayerListener

import io.fastpix.data.domain.listeners.PlayerListener
import io.fastpix.data.domain.model.BandwidthModel
import io.fastpix.data.domain.model.ErrorModel
class MyPlayerListener : PlayerListener {
 override fun playerHeight(): Int? = player.videoSize.height
 override fun playerWidth(): Int? = player.videoSize.width
 override fun videoSourceWidth(): Int? = player.videoFormat?.width
 override fun videoSourceHeight(): Int? = player.videoFormat?.height
 override fun playHeadTime(): Int? = player.currentPosition.toInt()
 override fun mimeType(): String? = player.videoFormat?.sampleMimeType
 override fun sourceFps(): String? = player.videoFormat?.frameRate?.toString()
 override fun sourceAdvertisedBitrate(): String? = player.videoFormat?.bitrate?.toString()
 override fun sourceAdvertiseFrameRate(): Int? = player.videoFormat?.frameRate
 override fun sourceDuration(): Int? = player.duration.toInt()
 override fun isPause(): Boolean? = !player.isPlaying
 override fun isAutoPlay(): Boolean? = player.isAutoPlay()
 override fun preLoad(): Boolean? = player.preLoad
 override fun isBuffering(): Boolean? = player.playbackState == Player.STATE_BUFFERING
 override fun playerCodec(): String? = player.videoFormat?.codecs
 override fun sourceHostName(): String? =
 Uri.parse(player.currentMediaItem?.localConfiguration?.uri.toString()).host
 override fun isLive(): Boolean? = player.isCurrentMediaItemLive
 override fun sourceUrl(): String? = player.currentMediaItem?.localConfiguration?.uri.toString()
 override fun isFullScreen(): Boolean? = isPlayerFullScreen
 override fun getBandWidthData(): BandwidthModel {
 return BandwidthModel(
 bandwidth = player.currentBandwidthEstimate.toString(),
 // Add other bandwidth metrics
 )
 }
 override fun getPlayerError(): ErrorModel {
 return ErrorModel(
 errorCode = player.playerError?.errorCode?.toString(),
 errorMessage = player.playerError?.message
 )
 }
 override fun getVideoCodec(): String? = player.videoFormat?.codecs
 override fun getSoftwareName(): String? = "software-name"
 override fun getSoftwareVersion(): String? = "software-version"
}

3. Dispatch Events

import io.fastpix.data.domain.enums.PlayerEventType
// When player is ready
fastPixSDK.dispatchEvent(PlayerEventType.playerReady)
// When video begins
fastPixSDK.dispatchEvent(PlayerEventType.viewBegin)
// When playback starts
fastPixSDK.dispatchEvent(PlayerEventType.play)
fastPixSDK.dispatchEvent(PlayerEventType.playing)
// When user pauses
fastPixSDK.dispatchEvent(PlayerEventType.pause)
// When seeking
fastPixSDK.dispatchEvent(PlayerEventType.seeking)
fastPixSDK.dispatchEvent(PlayerEventType.seeked)
// When buffering
fastPixSDK.dispatchEvent(PlayerEventType.buffering)
fastPixSDK.dispatchEvent(PlayerEventType.buffered)
// When quality changes
fastPixSDK.dispatchEvent(PlayerEventType.variantChanged)
// When video ends
fastPixSDK.dispatchEvent(PlayerEventType.ended)
fastPixSDK.dispatchEvent(PlayerEventType.viewCompleted)
// On errors
fastPixSDK.dispatchEvent(PlayerEventType.error)

4. Clean Up

override fun onDestroy() {
 super.onDestroy()
 fastPixSDK.release()
}

Configuration

SDKConfiguration

VideoDataDetails

PlayerDataDetails

CustomDataDetails

Event Types

Dependencies

Changelog

Support

License