Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for the pillarbox-player module #817

Merged
merged 17 commits into from
Nov 28, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Nov 27, 2024

Pull request

Description

This updates the KDoc for every public API in the pillarbox-player module.

Changes made

  • Update documentation in pillarbox-player.
  • Add a missing case in StringUtil. discontinuityReasonString() (only actual code change 45be0ac).
  • Fix references to the build.yml workflow, following the merge of Update GitHub Actions workflows #818.

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@MGaetan89 MGaetan89 linked an issue Nov 27, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Nov 27, 2024

Code Coverage

Overall Project 48.66% 🟢
Files changed 100% 🟢

Module Coverage
:pillarbox-player 56.59% 🟢
Files
Module File Coverage
:pillarbox-player MediaItemTrackerData.kt 100% 🟢
PillarboxTrackSelector.kt 100% 🟢
PillarboxBandwidthMeter.kt 100% 🟢
PillarboxRenderersFactory.kt 100% 🟢
BlockedTimeRange.kt 100% 🟢
Format.kt 100% 🟢
VideoSize.kt 100% 🟢
PlayerCommands.kt 100% 🟢
AssetLoader.kt 100% 🟢
Asset.kt 100% 🟢
TracksExtensions.kt 100% 🟢
PendingIntentUtils.kt 100% 🟢
StringUtil.kt 100% 🟢
Heartbeat.kt 98.52% 🟢
MediaMetadata.kt 98.41% 🟢
PillarboxOkHttp.kt 97.56% 🟢
PlaybackMetrics.kt 97.47% 🟢
Track.kt 93.83% 🟢
Tracks.kt 93.67% 🟢
PlaybackSessionManager.kt 93.03% 🟢
PillarboxMediaDescriptionAdapter.kt 92.89% 🟢
PillarboxMediaSource.kt 87.35% 🟢
PillarboxPreloadManager.kt 85.88% 🟢
TotalPlaytimeCounter.kt 85.71% 🟢
UrlAssetLoader.kt 80.65% 🟢
PillarboxBuilder.kt 78.55% 🟢
PillarboxLoadControl.kt 78.38% 🟢
TimeRange.kt 78.38% 🟢
EventMessageData.kt 77.29% 🟢
Message.kt 76.03% 🟢
PillarboxExoPlayer.kt 72.69% 🟢
PillarboxEventLogger.kt 69.92% 🟢
PlayerCallbackFlow.kt 69.14% 🟢
MetricsCollector.kt 65.82% 🟢
PillarboxAnalyticsCollector.kt 64.19% 🟢
Chapter.kt 60.87% 🟢
Session.kt 58.12% 🟢
PillarboxMediaSourceFactory.kt 52.3% 🟢
DebugLogger.kt 50% 🟢
Player.kt 43.91% 🟢
ErrorMessageData.kt 43.33% 🟢
PillarboxPlayer.kt 25% 🟢
Timings.kt 18.18% 🟢
MonitoringMessageHandler.kt 3.55% 🟢
TrackSelectionParameters.kt 1.46% 🟢
PlaybackService.kt 0% 🟢
PreloadConfiguration.kt 0% 🟢
Credit.kt 0% 🟢
PlayerTracks.kt 0% 🟢
PillarboxNotificationManager.kt 0% 🟢
MessageData.kt 0% 🟢
PlayerExtensions.kt 0% 🟢
BitrateUtil.kt 0% 🟢
PillarboxHttpClient.kt 0% 🟢

@MGaetan89 MGaetan89 requested a review from StaehliJ November 27, 2024 13:31
@MGaetan89 MGaetan89 force-pushed the update_player_documentation branch from 07090f0 to c8a116a Compare November 27, 2024 16:32
@StaehliJ StaehliJ added this pull request to the merge queue Nov 28, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2024
@MGaetan89 MGaetan89 added this pull request to the merge queue Nov 28, 2024
Merged via the queue into main with commit a987d49 Nov 28, 2024
9 checks passed
@MGaetan89 MGaetan89 deleted the update_player_documentation branch November 28, 2024 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Provide a consolidated documentation for Pillarbox
2 participants