API リファレンス - WebMeeting

Hylable Web 会議システムを操作するソフトウェアを開発するためのモジュールです。 最初に WebMeetingClient クラスのインスタンスを作成して、そのメソッドを実行することで操作を行います。

データは、以下の dataclass で定義されるクラスのオブジェクトとして扱います

class hylable.webmeeting.WebMeetingClient(profile_name: str = 'default')

Hylable Web 会議システム との通信を行うクラス

add_guest_url(room_id: str, topic: str = '', start: datetime | None = None, end: datetime | None = None) → GuestUrl

ゲスト用のURLを追加する関数

パラメータ:

guesturl (GuestUrl) -- 追加するゲスト用のURL

サンプル

>>> client = WebMeetingClient()
>>> guesturl = GuestUrl()
>>> client.add_guest_url(guesturl)
add_room(room: Room) → Room

会議ルームを追加する関数

パラメータ:

room (Room) -- 追加する会議ルーム。name と course_id が必要

戻り値:

追加した会議ルーム

戻り値の型:

Room

サンプル

>>> client = WebMeetingClient()
>>> room = Room(name="test")
>>> client.add_room(room)
del_guest_url(guesturl: GuestUrl)

ゲスト用のURLを削除する関数

パラメータ:

guesturl (GuestUrl) -- 削除するゲスト用のURL

サンプル

>>> client = WebMeetingClient()
>>> guesturl = GuestUrl()
>>> client.del_guest_url(guesturl)
del_room(room: Room)

会議ルームを削除する関数

パラメータ:

room (Room) -- 削除する会議ルーム

サンプル

>>> client = WebMeetingClient()
>>> room = Room(name="test")
>>> client.del_room(room)
get_guest_urls(room_id: str = '') → list[GuestUrl]

ゲスト用のURLのリストを取得する関数

パラメータ:

room_id (str) -- 取得する会議ルームのID

戻り値:

ゲスト用のURLのリスト

戻り値の型:

list[GuestUrl]

サンプル

>>> client = WebMeetingClient()
>>> all_urls = client.get_guest_urls()
>>> room = client.get_rooms()[0]
>>> url = client.get_guest_urls(room.id)
get_room(room: Room) → Room

会議ルームの詳細を取得する関数

パラメータ:

room (Room) -- 取得する会議ルーム

戻り値:

取得した会議ルーム

戻り値の型:

Room

サンプル

>>> client = WebMeetingClient()
>>> room = [r for r in rooms if r.name == "target"][0]
>>> room = client.get_room(room)
get_rooms() → list[Room]

すべての会議ルームのリストを得る関数

戻り値:

ルームのリスト

戻り値の型:

list[Room]

サンプル

>>> client = WebMeetingClient()
>>> rooms = client.get_rooms()

Hylable Web 会議システムを操作するソフトウェアを開発するためのモジュールです。 最初に WebMeetingClient クラスのインスタンスを作成して、そのメソッドを実行することで操作を行います。

データは、以下の dataclass で定義されるクラスのオブジェクトとして扱います

class hylable.webmeeting.GuestUrl(rawdata: dict = <factory>, application: str = 'remote', createdAt: ~datetime.datetime | None = None, start: ~datetime.datetime | None = None, end: ~datetime.datetime | None = None, token: str = '', room_id: str = '', metadata: dict = <factory>, url: str = '')

ベースクラス: BaseDataModel

ゲスト用のURLを表す dataclass

createdAt

URL の作成日時

Type:

datetime

start

URL の有効期限の開始日時

Type:

datetime

end

URL の有効期限の終了日時

Type:

datetime

room_id

URL のルームID

Type:

str

metadata

URL のメタデータ

Type:

dict

url

URL

Type:

str

set_url(client) → None

URLを設定する関数

パラメータ:

url (str) -- 設定するURL

class hylable.webmeeting.Room(rawdata: dict = <factory>, id: str = '', name: str = '', orgid: str = '', course_id: str = '', analysis: dict = <factory>, discussion_id: str = '', members: list = <factory>, status: str = '')

ベースクラス: BaseDataModel

Web会議ルームを表す dataclass

id

ルームのID

Type:

str

name

ルームの名前

Type:

str

orgid

組織のID

Type:

str

course_id

ルームに紐付けられているコースのID

Type:

str

analysis

ルームの分析結果を表す dict

activity

キーがメンバーID、値がアクティビティのフレームのリストである dict 詳細は hylable.hd.Discussion.frames を参照

turntake

dict の dict 、最初のキーがターンテイクの発生回数を表す。 詳細は hylable.hd.Discussion.stats を参照

tlot_ms

キーがメンバーID、当該メンバーの発話時間を表す dict 詳細は hylable.hd.Discussion.stats を参照

Type:

dict

discussion_id

分析中の場合、ルームのディスカッションID

Type:

str

members

ルームに参加しているメンバーのリスト。 リストの要素は {'position': int, 'members': str, 'is_left': bool} である。 それぞれの key の意味は以下の通り

position

0 から 360 の数値で、メンバーの仮想的な角度を表す。

member

hylable.hd.Member クラスのオブジェクトにおけるメンバーのIDを表す。

is_left

メンバーがルームから退出したかどうかを表す。

Type:

list

status

ルームのステータス

closed

ルームが閉じられている

open

ルームが開かれている

inqueue

ルームを開いている途中
Type:

str