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

CORE-5261 Stoplight documentation #39

Merged
merged 3 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
.externalNativeBuild
.cxx
local.properties
.spectral.mjs
20 changes: 20 additions & 0 deletions .stoplight.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"exclude": [
".git*",
".idea",
"app",
"gradle*",
"playback-sdk-android",
"build*",
"settings*",
"docs"
],
"formats": {
"markdown": {
"rootDir": "docs",
"include": [
"**/*.md"
]
}
}
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ To play on-demand and live videos that require authorization, at some point befo

Then the same token should be passed into the `loadPlayer(entryID, authorizationToken, onError)` method of `PlaybackSDkManager`. For the free videos that user should be able to watch without logging in, starting the session is not required and `authorizationToken` can be set to an empty string or `null`.

> \[!NOTE]
> \[NOTE]
> If the user is authenticated, has enough access level to watch a video, the session was started and the same token was passed to the player but the videos still throw a 401 error, it might be related to these requests having different user-agent headers.

## Configure user-agent
Expand Down Expand Up @@ -189,7 +189,7 @@ To use the Google Chromecast support, use the `updateCastContext` method of the
...
}
```
# Bitmovin analytics
## Bitmovin analytics

Currently SDK support tracking analytics on Bitmovin service. In case you have a logged-in user and want to track Bitmovin analytics for the current session, you need to pass the user's ID in the `analyticsViewerId` parameter.

Expand All @@ -204,7 +204,7 @@ Currently SDK support tracking analytics on Bitmovin service. In case you have a
}
```

# Resources
## Resources

- **Tutorial:** [Tutorial](https://streamamg.github.io/playback-sdk-android/tutorials/playbacksdk/getstarted)
- **Demo app:** [GitHub Repository](https://github.com/StreamAMG/playback-demo-android)