Skip to content

Commit

Permalink
docs: regenerate some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nemo2011 committed Dec 16, 2024
1 parent 4a3283f commit c1cc94e
Show file tree
Hide file tree
Showing 8 changed files with 198 additions and 117 deletions.
58 changes: 0 additions & 58 deletions docs/modules/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,28 +87,6 @@ from bilibili_api import article



### def get_type()

获取专栏类型(专栏/笔记)



**Returns:** ArticleType: 专栏类型




### def is_note()

检查专栏是否笔记



**Returns:** bool: 是否笔记




### def json()

转换为 JSON 数据
Expand Down Expand Up @@ -163,27 +141,6 @@ from bilibili_api import article



### def turn_to_note()

对于完全与 opus 兼容的部分的特殊专栏,将 Article 对象转换为 Dynamic 对象。



**Returns:** Note: 笔记类




### def turn_to_opus()

对于 SPECIAL_ARTICLE,将其转为图文



**Returns:** None



---

## class ArticleList()
Expand Down Expand Up @@ -243,21 +200,6 @@ from bilibili_api import article



---

## class ArticleType()

**Extend: enum.Enum**

专栏类型

- ARTICLE: 普通专栏,不与 opus 图文兼容。
- OPUS : opus。
- SPECIAL_ARTICLE: 特殊专栏,与 opus 兼容。




---

## async def get_article_rank()
Expand Down
155 changes: 146 additions & 9 deletions docs/modules/bangumi.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ from bilibili_api import bangumi



### def get_media_id()
### async def get_media_id()

获取 media_id

Expand Down Expand Up @@ -109,7 +109,7 @@ from bilibili_api import bangumi



### def get_raw()
### async def get_raw()

原始初始化数据

Expand All @@ -120,7 +120,7 @@ from bilibili_api import bangumi



### def get_season_id()
### async def get_season_id()

获取季度 id

Expand Down Expand Up @@ -157,7 +157,7 @@ from bilibili_api import bangumi



### def get_up_info()
### async def get_up_info()

番剧上传者信息 出差或者原版

Expand All @@ -168,7 +168,7 @@ from bilibili_api import bangumi



### def set_media_id()
### async def set_media_id()

设置 media_id

Expand All @@ -181,7 +181,7 @@ from bilibili_api import bangumi



### def set_ssid()
### async def set_ssid()

设置季度 id

Expand Down Expand Up @@ -246,9 +246,35 @@ from bilibili_api import bangumi
| - | - | - |
| epid | int | 番剧 epid |
| credential | Union[Credential, None] | 凭据. Defaults to None. |
| initial_state_retry_times | int | 番剧剧集加载初始化信息请求重试次数上限设置. Defaults to 3. |


### def get_bangumi()
### async def get_ai_conclusion()

获取稿件 AI 总结结果。


| name | type | description |
| - | - | - |
| up_mid | Union[Optional,, None] | up 主的 mid。 |

**Returns:** dict: 调用 API 返回的结果。




### async def get_aid()

获取 AID。



**Returns:** str: AID。




### async def get_bangumi()

获取对应的番剧

Expand All @@ -270,6 +296,17 @@ from bilibili_api import bangumi



### async def get_bvid()

获取 BVID。



**Returns:** str: BVID。




### async def get_cid()

获取稿件 cid
Expand Down Expand Up @@ -311,6 +348,8 @@ from bilibili_api import bangumi
| name | type | description |
| - | - | - |
| date | Union[datetime.date, None] | 指定某一天查询弹幕. Defaults to None. (不指定某一天) |
| from_seg | Union[int, None] | 从第几段开始(0 开始编号,None 为从第一段开始,一段 6 分钟). Defaults to None. |
| to_seg | Union[int, None] | 到第几段结束(0 开始编号,None 为到最后一段,包含编号的段,一段 6 分钟). Defaults to None. |

**Returns:** dict[Danmaku]: 弹幕列表

Expand Down Expand Up @@ -344,7 +383,7 @@ from bilibili_api import bangumi



**Returns:** HTML 中的数据
**Returns:** Tuple[dict, InitialDataType]: 前半部分为数据,后半部分为数据类型(__INITIAL_STATE____NEXT_DATA)



Expand All @@ -363,7 +402,68 @@ from bilibili_api import bangumi



### def set_epid()
### async def get_pbp()

获取高能进度条



**Returns:** 调用 API 返回的结果




### async def get_player_info()

获取视频上一次播放的记录,字幕和地区信息。需要分集的 cid, 返回数据中含有json字幕的链接



**Returns:** 调用 API 返回的结果




### async def get_subtitle()

获取字幕信息



**Returns:** 调用 API 返回的结果




### async def recall_danmaku()

撤回弹幕。


| name | type | description |
| - | - | - |
| dmid | int | 弹幕 id |

**Returns:** dict: 调用 API 返回的结果。




### async def send_danmaku()

发送弹幕。


| name | type | description |
| - | - | - |
| danmaku | Danmaku \| None | Danmaku 类。 |

**Returns:** dict: 调用 API 返回的结果。




### async def set_epid()

设置 epid

Expand All @@ -376,6 +476,43 @@ from bilibili_api import bangumi



### async def submit_subtitle()

上传字幕

字幕数据 data 参考:

```json
{
"font_size": "float: 字体大小,默认 0.4",
"font_color": "str: 字体颜色,默认 "#FFFFFF"",
"background_alpha": "float: 背景不透明度,默认 0.5",
"background_color": "str: 背景颜色,默认 "#9C27B0"",
"Stroke": "str: 描边,目前作用未知,默认为 "none"",
"body": [
{
"from": "int: 字幕开始时间(秒)",
"to": "int: 字幕结束时间(秒)",
"location": "int: 字幕位置,默认为 2",
"content": "str: 字幕内容"
}
]
}
```


| name | type | description |
| - | - | - |
| lan | str | 字幕语言代码,参考 https |
| data | Dict | 字幕数据 |
| submit | bool | 是否提交,不提交为草稿 |
| sign | bool | 是否署名 |

**Returns:** dict: API 调用返回结果




---

## class IndexFilter()
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/channel_series.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ from bilibili_api import channel_series
| credential | Credential | 凭证. Defaults to None. |


### def get_meta()
### async def get_meta()

获取元数据

Expand Down
Loading

0 comments on commit c1cc94e

Please sign in to comment.