addMetadata command

ジャンプ先: 概要. 戻り値. キーワード. 関連. フラグ. Python 例.

概要

addMetadata([channelName=string], [channelType=string], [indexType=string], [scene=boolean], [streamName=string], [structure=string])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

addMetadata は、取り消し可能、照会可能、および編集不可能です。

1 つまたは複数の選択したオブジェクトに対するメタデータストラクチャのアタッチメントを定義します。これにより、後で editMetadata コマンドを使用して設定するプレースホルダと空のメタデータストリームが作成されます。これは、ノードにおける addAttr コマンド(データ説明が追加されるが、データは実際に設定されない)と同様の概念です。

メタデータストラクチャを割り当てるときは、次のフラグを指定する必要があります。channelName はメタデータのチャネルタイプ(「vertex」など)、streamName は作成するメタデータストリームの名前、structure はメタデータの内容を定義するストラクチャタイプの名前です。indexType フラグはオプションです。このフラグを指定しない場合、インデックスは標準の数値と推測されます。

メタデータの情報は、さまざまなレベルで照会できます。照会可能なすべての引数の一覧については以下の表を参照してください。それぞれの場合において、非照会引数のいずれかを指定すると、照会中に調べるメタデータの一覧がフィルタされます。すべての照会で、照会する単一のオブジェクトを選択する必要があります。

たとえば、他の引数を指定せずに channelName フラグを照会すると、メタデータを含む選択されたオブジェクトのすべてのチャネルタイプの一覧が返されます。indexType フラグを指定して channelName フラグを照会すると、その特定のタイプのインデックスを使用するメタデータストリームを含むチャネルタイプのみ返されます。

メタデータを持つチャネルタイプのリストを返すには、channelName フラグを照会します。
指定したストリームに割り当てられているストラクチャ(存在する場合)の名前を返すには、channelName フラグと streamName フラグを指定し、structure フラグを照会します。
特定のチャネルタイプに割り当てられているすべてのストリームのリストを返すには、channelName を指定し、streamName を照会します。
特定の channelName を指定せずに streamName を照会した場合、すべてのメタデータストリームにおける(channelName、streamName)のペアのリストが返されます。

フラグの組み合わせ:

ChannelName ndexType StreamName Structure   Create   Can Query
     0          0          0         0         X        ChannelName, StreamName, Structure
     0          0          0         1         X        ChannelName, StreamName, IndexType
     0          0          1         0         X        ChannelName, Structure, IndexType
     0          0          1         1         X        ChannelName, IndexType
     0          1          0         0         X        ChannelName, StreamName, Structure
     0          1          0         1         X        ChannelName, StreamName
     0          1          1         0         X        ChannelName, Structure
     0          1          1         1         X        ChannelName
     1          0          0         0         X        StreamName, Structure, IndexType
     1          0          0         1         X        StreamName, IndexType
     1          0          1         0         X        Structure, IndexType
     1          0          1         1        (a)       IndexType
     1          1          0         0         X        StreamName, Structure
     1          1          0         1         X        StreamName
     1          1          1         0         X        Structure
     1          1          1         1        (b)       X
    (a) 既定のインデックス タイプの空のメタデータ ストリームを割り当てる
    (b) 指定したインデックス タイプの空のメタデータ ストリームを割り当てる

戻り値

string[]	新しいストリームが正常に追加されたノードの一覧(作成モード)
string[]	channelName フラグを照会する場合のオブジェクトに関するメタデータを含むチャネルタイプの一覧
string[]	streamName フラグを照会する場合のオブジェクト上のストリーム名の一覧
string[]	structure フラグを照会する場合にオブジェクトのメタデータストリームで使用されるストラクチャの一覧
string[]	indexType フラグを照会する場合にオブジェクトで使用されるインデックスタイプの一覧

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

キーワード

metadata, component, stream, channel, association

フラグ

channelName, channelType, indexType, scene, streamName, structure

ロングネーム(ショートネーム) 引数タイプ プロパティ

channelName(cn) string