HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdMediaTokensType Class Reference

#include <tokens.h>

Public Member Functions

USDMEDIA_API UsdMediaTokensType ()
 

Public Attributes

const TfToken auralMode
 "auralMode" More...
 
const TfToken defaultImage
 "defaultImage" More...
 
const TfToken endTime
 "endTime" More...
 
const TfToken filePath
 "filePath" More...
 
const TfToken gain
 "gain" More...
 
const TfToken loopFromStage
 "loopFromStage" More...
 
const TfToken loopFromStart
 "loopFromStart" More...
 
const TfToken loopFromStartToEnd
 "loopFromStartToEnd" More...
 
const TfToken mediaOffset
 "mediaOffset" More...
 
const TfToken nonSpatial
 "nonSpatial" More...
 
const TfToken onceFromStart
 "onceFromStart" More...
 
const TfToken onceFromStartToEnd
 "onceFromStartToEnd" More...
 
const TfToken playbackMode
 "playbackMode" More...
 
const TfToken previews
 "previews" More...
 
const TfToken previewThumbnails
 "previews:thumbnails" More...
 
const TfToken previewThumbnailsDefault
 "previews:thumbnails:default" More...
 
const TfToken spatial
 "spatial" More...
 
const TfToken startTime
 "startTime" More...
 
const TfToken thumbnails
 "thumbnails" More...
 
const TfToken AssetPreviewsAPI
 "AssetPreviewsAPI" More...
 
const TfToken SpatialAudio
 "SpatialAudio" More...
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above. More...
 

Detailed Description

UsdMediaTokens provides static, efficient TfTokens for use in all public USD API.

These tokens are auto-generated from the module's schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

UsdMediaTokens also contains all of the allowedTokens values declared for schema builtin attributes of 'token' scene description type. Use UsdMediaTokens like so:

gprim.GetMyTokenValuedAttr().Set(UsdMediaTokens->auralMode);

Definition at line 63 of file tokens.h.

Constructor & Destructor Documentation

USDMEDIA_API UsdMediaTokensType::UsdMediaTokensType ( )

Member Data Documentation

const std::vector<TfToken> UsdMediaTokensType::allTokens

A vector of all of the tokens listed above.

Definition at line 150 of file tokens.h.

const TfToken UsdMediaTokensType::AssetPreviewsAPI

"AssetPreviewsAPI"

Schema identifer and family for UsdMediaAssetPreviewsAPI

Definition at line 144 of file tokens.h.

const TfToken UsdMediaTokensType::auralMode

"auralMode"

UsdMediaSpatialAudio

Definition at line 68 of file tokens.h.

const TfToken UsdMediaTokensType::defaultImage

"defaultImage"

Dictionary key in a Thumbnails dictionary for the default thumbnail image.

Definition at line 72 of file tokens.h.

const TfToken UsdMediaTokensType::endTime

"endTime"

UsdMediaSpatialAudio

Definition at line 76 of file tokens.h.

const TfToken UsdMediaTokensType::filePath

"filePath"

UsdMediaSpatialAudio

Definition at line 80 of file tokens.h.

const TfToken UsdMediaTokensType::gain

"gain"

UsdMediaSpatialAudio

Definition at line 84 of file tokens.h.

const TfToken UsdMediaTokensType::loopFromStage

"loopFromStage"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 88 of file tokens.h.

const TfToken UsdMediaTokensType::loopFromStart

"loopFromStart"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 92 of file tokens.h.

const TfToken UsdMediaTokensType::loopFromStartToEnd

"loopFromStartToEnd"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 96 of file tokens.h.

const TfToken UsdMediaTokensType::mediaOffset

"mediaOffset"

UsdMediaSpatialAudio

Definition at line 100 of file tokens.h.

const TfToken UsdMediaTokensType::nonSpatial

"nonSpatial"

Possible value for UsdMediaSpatialAudio::GetAuralModeAttr()

Definition at line 104 of file tokens.h.

const TfToken UsdMediaTokensType::onceFromStart

"onceFromStart"

Fallback value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 108 of file tokens.h.

const TfToken UsdMediaTokensType::onceFromStartToEnd

"onceFromStartToEnd"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 112 of file tokens.h.

const TfToken UsdMediaTokensType::playbackMode

"playbackMode"

UsdMediaSpatialAudio

Definition at line 116 of file tokens.h.

const TfToken UsdMediaTokensType::previews

"previews"

Dictionary key in the assetInfo dictionary for asset previews sub-dictionary.

Definition at line 120 of file tokens.h.

const TfToken UsdMediaTokensType::previewThumbnails

"previews:thumbnails"

Full key in the assetInfo dictionary for thumbnails previews dictionary.

Definition at line 124 of file tokens.h.

const TfToken UsdMediaTokensType::previewThumbnailsDefault

"previews:thumbnails:default"

Full key in the assetInfo dictionary for the "default" thumbnails in the previews dictionary.

Definition at line 128 of file tokens.h.

const TfToken UsdMediaTokensType::spatial

"spatial"

Fallback value for UsdMediaSpatialAudio::GetAuralModeAttr()

Definition at line 132 of file tokens.h.

const TfToken UsdMediaTokensType::SpatialAudio

"SpatialAudio"

Schema identifer and family for UsdMediaSpatialAudio

Definition at line 148 of file tokens.h.

const TfToken UsdMediaTokensType::startTime

"startTime"

UsdMediaSpatialAudio

Definition at line 136 of file tokens.h.

const TfToken UsdMediaTokensType::thumbnails

"thumbnails"

Dictionary key in the assetInfo["previews"] dictionary for thumbnails previews sub-dictionary.

Definition at line 140 of file tokens.h.


The documentation for this class was generated from the following file: