mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-17 19:42:14 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
90 lines
1.9 KiB
Markdown
90 lines
1.9 KiB
Markdown
[youtubei.js](../../../README.md) / [Clients](../README.md) / Studio
|
|
|
|
# Class: Studio
|
|
|
|
## Constructors
|
|
|
|
### new Studio()
|
|
|
|
> **new Studio**(`session`): [`Studio`](Studio.md)
|
|
|
|
#### Parameters
|
|
|
|
• **session**: [`Session`](../../../classes/Session.md)
|
|
|
|
#### Returns
|
|
|
|
[`Studio`](Studio.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/core/clients/Studio.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/clients/Studio.ts#L26)
|
|
|
|
## Methods
|
|
|
|
### updateVideoMetadata()
|
|
|
|
> **updateVideoMetadata**(`video_id`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
|
|
|
Updates the metadata of a video.
|
|
|
|
#### Parameters
|
|
|
|
• **video\_id**: `string`
|
|
|
|
• **metadata**: `Partial`\<`object`\>
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
|
|
|
#### Example
|
|
|
|
```ts
|
|
const videoId = 'abcdefg';
|
|
const thumbnail = fs.readFileSync('./my_awesome_thumbnail.jpg');
|
|
|
|
const response = await yt.studio.updateVideoMetadata(videoId, {
|
|
tags: [ 'astronomy', 'NASA', 'APOD' ],
|
|
title: 'Artemis Mission',
|
|
description: 'A nicely written description...',
|
|
category: 27,
|
|
license: 'creative_commons',
|
|
thumbnail,
|
|
// ...
|
|
});
|
|
```
|
|
|
|
#### Defined in
|
|
|
|
[src/core/clients/Studio.ts:48](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/clients/Studio.ts#L48)
|
|
|
|
***
|
|
|
|
### upload()
|
|
|
|
> **upload**(`file`, `metadata`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
|
|
|
Uploads a video to YouTube.
|
|
|
|
#### Parameters
|
|
|
|
• **file**: `BodyInit`
|
|
|
|
• **metadata**: `Partial`\<`object`\> = `{}`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
|
|
|
|
#### Example
|
|
|
|
```ts
|
|
const file = fs.readFileSync('./my_awesome_video.mp4');
|
|
const response = await yt.studio.upload(file.buffer, { title: 'Wow!' });
|
|
```
|
|
|
|
#### Defined in
|
|
|
|
[src/core/clients/Studio.ts:151](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/clients/Studio.ts#L151)
|