VideoFilter class

Filter the results returns by the Holodex API /videos endpoint

  • @Freezed(fromJson: false, toJson: true)


VideoFilter({@JsonKey(name: 'channel_id', includeIfNull: false) String? channelId, @JsonKey(name: 'id', toJson: nullStringListIfEmpty, includeIfNull: false) @Default([]) List<String> ids, @JsonKey(toJson: concatIncludesList, name: 'include', includeIfNull: false) @Default([]) List<Includes> includes, @Default([]) @JsonKey(toJson: concatLanguageListWithDefault, name: 'lang') List<Language> languages, @JsonKey(toJson: intToString) @Default(25) int limit, @JsonKey(name: 'max_upcoming_hours', toJson: intToStringNullable, includeIfNull: false) int? maxUpcomingHours, @JsonKey(name: 'mentioned_channel_id', includeIfNull: false) String? mentionedChannelId, @JsonKey(toJson: intToString) @Default(0) int offset, @JsonKey(toJson: orderToString) @Default(Order.descending) Order order, @JsonKey(name: 'org', toJson: organizationToString, includeIfNull: false) Organization? organization, @JsonKey(toJson: paginatedToString) @Default(false) bool paginated, @JsonKey(toJson: concatVideoSortList, includeIfNull: false) @Default([VideoSort.availableAt]) List<VideoSort> sort, @JsonKey(toJson: concatVideoStatusList, includeIfNull: false) @Default([]) List<VideoStatus> status, @JsonKey(includeIfNull: false) String? topic, @JsonKey(toJson: videoTypeToString, includeIfNull: false) @JsonKey(includeIfNull: false) VideoType? type})
Filter the results returns by the Holodex API channel endpoints


channelId String?
Filter by video uploader channel ID
no setterinherited
copyWith → $VideoFilterCopyWith<VideoFilter>
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
ids List<String>
Youtube Video IDs. If Specified, only this video can be returned (may be filtered out by other conditions though)
no setterinherited
includes List<Includes>
Request extra data be included in the results. They are not guarenteed to be returned.
no setterinherited
languages List<Language>
Filter by the Language
no setterinherited
limit int
Limit the number of results returned. Maximum value of 50
no setterinherited
maxUpcomingHours int?
Number of maximum hours upcoming to get upcoming videos by (for rejecting waiting rooms that are two years out)
no setterinherited
mentionedChannelId String?
Filter by mentioned channel id, excludes itself. Generally used to find collabs/clips that include the requested channel
no setterinherited
offset int
Receive results starting at this number in the array from the Holodex API
no setterinherited
order Order
Order results by ascending or descending
no setterinherited
organization Organization?
Filter by clips that feature the org's talent or videos posted by the org's talent.
no setterinherited
paginated bool
If paginated is set to true, returns PaginatedVideos with total, otherwise returns PaginatedVideos without the total.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sort List<VideoSort>
Sort the returned data by this field
no setterinherited
status List<VideoStatus>
Filter by the video status
no setterinherited
topic String?
Filter by video topic ID
no setterinherited
type VideoType?
Filter by type of video, either clips or streams
no setterinherited


noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toJson() Map<String, dynamic>
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.