vimeo / vimeo/vimeo-networking-java
What should be the field filter to get play links?
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 128
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
Summary
The documentation strongly recommends applying field filters to reduce the amount of data we get back, but it doesn't explain the video output schema. What should the field filters be if we want to get the HLS/DASH links of a video we own?
The documentation only suggests:
vimeoApiClient.fetchVideo(
uri = uri,
fieldFilter = null,
queryParams = null,
cacheControl = null,
callback = vimeoCallback(
onSuccess = {
// Use the video.
},
onError = {
// Voice the error.
}
)
)
and then
val dashLink: String? = video.play?.dash?.link
val hlsLink: String? = video.play?.hls?.link
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the documentation for vimeoApiClient.fetchVideo, especially the fieldFilter parameter and the video.play output schema. Determine which field filters expose the HLS and DASH links for an owned video, then update the documentation with those filters and a matching usage example. Done means a reader can retrieve both links without guessing the response fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100