mirror of
https://github.com/TeamPiped/piped_dart.git
synced 2024-08-14 22:27:49 +00:00
Initial commit.
This commit is contained in:
FireMasterK
commit
d0203d7c63
39 changed files with 2880 additions and 0 deletions
23
doc/ChannelInfo.md
Normal file
23
doc/ChannelInfo.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# piped_api.model.ChannelInfo
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**avatarUrl** | **String** | The URL of the channel's avatar. | [optional]
|
||||
**bannerUrl** | **String** | The URL of the channel's banner. | [optional]
|
||||
**description** | **String** | The channel's description. | [optional]
|
||||
**id** | **String** | The ID of the channel. | [optional]
|
||||
**name** | **String** | The name of the channel. | [optional]
|
||||
**nextpage** | **String** | The parameter used to get the next page of related videos. | [optional]
|
||||
**relatedStreams** | [**BuiltList<StreamItem>**](StreamItem.md) | | [optional]
|
||||
**subscriberCount** | **int** | The number of subscribers the channel has. | [optional]
|
||||
**verified** | **bool** | Whether the channel is verified. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
doc/ExceptionError.md
Normal file
16
doc/ExceptionError.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# piped_api.model.ExceptionError
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **String** | The stacktrace provided by the server. |
|
||||
**message** | **String** | The error message from the stacktrace. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
doc/Regions.md
Normal file
14
doc/Regions.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# piped_api.model.Regions
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
doc/Stream.md
Normal file
28
doc/Stream.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# piped_api.model.Stream
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**url** | **String** | The URL of the stream. | [optional]
|
||||
**format** | **String** | The format of the stream. | [optional]
|
||||
**quality** | **String** | The quality of the stream. | [optional]
|
||||
**mimeType** | **String** | The mime type of the stream. | [optional]
|
||||
**codec** | **String** | The codec of the stream. | [optional]
|
||||
**videoOnly** | **bool** | | [optional]
|
||||
**bitrate** | **int** | | [optional]
|
||||
**initStart** | **int** | | [optional]
|
||||
**initEnd** | **int** | | [optional]
|
||||
**indexStart** | **int** | | [optional]
|
||||
**indexEnd** | **int** | | [optional]
|
||||
**width** | **int** | | [optional]
|
||||
**height** | **int** | | [optional]
|
||||
**fps** | **int** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
24
doc/StreamItem.md
Normal file
24
doc/StreamItem.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# piped_api.model.StreamItem
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**duration** | **int** | The duration of the video in seconds. |
|
||||
**thumbnail** | **String** | The thumbnail of the video. |
|
||||
**title** | **String** | The title of the video. |
|
||||
**uploadedDate** | **String** | The relative date the video was uploaded on. | [optional]
|
||||
**uploaderAvatar** | **String** | The avatar of the channel of the video. | [optional]
|
||||
**uploaderName** | **String** | The name of the channel of the video. | [optional]
|
||||
**uploaderUrl** | **String** | The relative URL of the channel of the video. | [optional]
|
||||
**uploaderVerified** | **bool** | Whether or not the channel has a verified badge. | [optional]
|
||||
**url** | **String** | The relative URL to the video. |
|
||||
**views** | **int** | The number of views the video has. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
233
doc/UnauthenticatedApi.md
Normal file
233
doc/UnauthenticatedApi.md
Normal file
|
|
@ -0,0 +1,233 @@
|
|||
# piped_api.api.UnauthenticatedApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://pipedapi.kavin.rocks*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**channelInfoId**](UnauthenticatedApi.md#channelinfoid) | **GET** /channel/{channelId} | Gets Channel Information
|
||||
[**channelInfoName**](UnauthenticatedApi.md#channelinfoname) | **GET** /c/{name} | Gets Channel Information
|
||||
[**channelInfoUsername**](UnauthenticatedApi.md#channelinfousername) | **GET** /user/{username} | Gets Channel Information
|
||||
[**streamInfo**](UnauthenticatedApi.md#streaminfo) | **GET** /streams/{videoId} | Gets Video Information
|
||||
[**trending**](UnauthenticatedApi.md#trending) | **GET** /trending | Gets all Trending Videos
|
||||
|
||||
|
||||
# **channelInfoId**
|
||||
> ChannelInfo channelInfoId(channelId)
|
||||
|
||||
Gets Channel Information
|
||||
|
||||
Gets all available Channel information about a channel.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
|
||||
final api = PipedApi().getUnauthenticatedApi();
|
||||
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.
|
||||
|
||||
try {
|
||||
final response = api.channelInfoId(channelId);
|
||||
print(response);
|
||||
} catch on DioError (e) {
|
||||
print('Exception when calling UnauthenticatedApi->channelInfoId: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**channelId** | **String**| The channel ID of the YouTube channel you want to get information about. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ChannelInfo**](ChannelInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **channelInfoName**
|
||||
> ChannelInfo channelInfoName(name)
|
||||
|
||||
Gets Channel Information
|
||||
|
||||
Gets all available Channel information about a channel.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
|
||||
final api = PipedApi().getUnauthenticatedApi();
|
||||
final String name = Dream; // String | The name of the YouTube channel you want to get information about.
|
||||
|
||||
try {
|
||||
final response = api.channelInfoName(name);
|
||||
print(response);
|
||||
} catch on DioError (e) {
|
||||
print('Exception when calling UnauthenticatedApi->channelInfoName: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **String**| The name of the YouTube channel you want to get information about. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ChannelInfo**](ChannelInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **channelInfoUsername**
|
||||
> ChannelInfo channelInfoUsername(username)
|
||||
|
||||
Gets Channel Information
|
||||
|
||||
Gets all available Channel information about a channel.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
|
||||
final api = PipedApi().getUnauthenticatedApi();
|
||||
final String username = DreamTraps; // String | The username of the YouTube channel you want to get information about.
|
||||
|
||||
try {
|
||||
final response = api.channelInfoUsername(username);
|
||||
print(response);
|
||||
} catch on DioError (e) {
|
||||
print('Exception when calling UnauthenticatedApi->channelInfoUsername: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**username** | **String**| The username of the YouTube channel you want to get information about. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ChannelInfo**](ChannelInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **streamInfo**
|
||||
> VideoInfo streamInfo(videoId)
|
||||
|
||||
Gets Video Information
|
||||
|
||||
Gets all available Stream information about a video.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
|
||||
final api = PipedApi().getUnauthenticatedApi();
|
||||
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get information about.
|
||||
|
||||
try {
|
||||
final response = api.streamInfo(videoId);
|
||||
print(response);
|
||||
} catch on DioError (e) {
|
||||
print('Exception when calling UnauthenticatedApi->streamInfo: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**videoId** | **String**| The video ID of the YouTube video you want to get information about. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**VideoInfo**](VideoInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **trending**
|
||||
> BuiltList<StreamItem> trending(region)
|
||||
|
||||
Gets all Trending Videos
|
||||
|
||||
Gets all Trending Videos in the requested country.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
|
||||
final api = PipedApi().getUnauthenticatedApi();
|
||||
final Regions region = US; // Regions | The Region to get trending videos from.
|
||||
|
||||
try {
|
||||
final response = api.trending(region);
|
||||
print(response);
|
||||
} catch on DioError (e) {
|
||||
print('Exception when calling UnauthenticatedApi->trending: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**region** | [**Regions**](.md)| The Region to get trending videos from. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BuiltList<StreamItem>**](StreamItem.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
16
doc/VideoInfo.md
Normal file
16
doc/VideoInfo.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# piped_api.model.VideoInfo
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:piped_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**audioStreams** | [**BuiltList<Stream>**](Stream.md) | | [optional]
|
||||
**relatedStreams** | [**BuiltList<StreamItem>**](StreamItem.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue