From 679f2e9bb885343366bd231167e17f5563cf07bd Mon Sep 17 00:00:00 2001 From: taizan-hokuto <55448286+taizan-hokuto@users.noreply.github.com> Date: Fri, 17 Apr 2020 00:07:20 +0900 Subject: [PATCH] Modify README --- README.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index aab5189..1ca82e0 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,8 @@ info.get_title() info.get_channel_id() ``` ## Function -### get_info(video_id, session) -Returns -------- -+ VideoInfo object. +### get_info(video_id, session) Parameters ---------- @@ -25,37 +22,42 @@ Parameters - session : session object of requests. +Returns +------- ++ VideoInfo object. + ## Attributes of VideoInfo object -### get_duration() -- 動画の長さ(アーカイブのみ。ライブ動画または待機画面の場合0) -### get_title() --   動画タイトル +### get_duration() +- 動画の長さ(秒。アーカイブのみ。ライブ動画または待機画面の場合、0が返ります。) -### get_title_escaped() --   動画タイトル(絵文字なし。GUIライブラリ等で絵文字が含まれていてエラーが出る場合はこちらを使用してください) +### get_title() +- 動画タイトル -### get_channel_id() +### get_title_escaped() +- 動画タイトル(絵文字なし。GUIライブラリ等で絵文字が含まれていてエラーが出る場合はこちらを使用してください) + +### get_channel_id() - チャンネルID -### get_thumbnail() --   動画サムネイルURL +### get_thumbnail() +- 動画サムネイルURL -### get_owner_name() --   配信者名 +### get_owner_name() +- 配信者名 -### get_owner_name_escaped() --   配信者名(絵文字なし) +### get_owner_name_escaped() +- 配信者名(絵文字なし) -### get_owner_image() +### get_owner_image() -   配信者プロフィール画像URL -### get_user_name() --   視聴者名 +### get_user_name() +- 視聴者名 -### get_user_name_escaped() --   視聴者名(絵文字なし) +### get_user_name_escaped() +- 視聴者名(絵文字なし) -### get_user_image() --   視聴者プロフィール画像URL +### get_user_image() +- 視聴者プロフィール画像URL