Loading...
Searching...
No Matches
UsdMediaTokensType Class Reference

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

#include <tokens.h>

Public Attributes

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

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);
USDMEDIA_API TfStaticData< UsdMediaTokensType > UsdMediaTokens
A global variable with static, efficient TfTokens for use in all public USD API.

Definition at line 63 of file tokens.h.

Member Data Documentation

◆ allTokens

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 150 of file tokens.h.

◆ AssetPreviewsAPI

const TfToken AssetPreviewsAPI

"AssetPreviewsAPI"

Schema identifer and family for UsdMediaAssetPreviewsAPI

Definition at line 144 of file tokens.h.

◆ auralMode

const TfToken auralMode

"auralMode"

UsdMediaSpatialAudio

Definition at line 68 of file tokens.h.

◆ defaultImage

const TfToken defaultImage

"defaultImage"

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

Definition at line 72 of file tokens.h.

◆ endTime

const TfToken endTime

"endTime"

UsdMediaSpatialAudio

Definition at line 76 of file tokens.h.

◆ filePath

const TfToken filePath

"filePath"

UsdMediaSpatialAudio

Definition at line 80 of file tokens.h.

◆ gain

const TfToken gain

"gain"

UsdMediaSpatialAudio

Definition at line 84 of file tokens.h.

◆ loopFromStage

const TfToken loopFromStage

"loopFromStage"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 88 of file tokens.h.

◆ loopFromStart

const TfToken loopFromStart

"loopFromStart"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 92 of file tokens.h.

◆ loopFromStartToEnd

const TfToken loopFromStartToEnd

"loopFromStartToEnd"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 96 of file tokens.h.

◆ mediaOffset

const TfToken mediaOffset

"mediaOffset"

UsdMediaSpatialAudio

Definition at line 100 of file tokens.h.

◆ nonSpatial

const TfToken nonSpatial

"nonSpatial"

Possible value for UsdMediaSpatialAudio::GetAuralModeAttr()

Definition at line 104 of file tokens.h.

◆ onceFromStart

const TfToken onceFromStart

"onceFromStart"

Fallback value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 108 of file tokens.h.

◆ onceFromStartToEnd

const TfToken onceFromStartToEnd

"onceFromStartToEnd"

Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()

Definition at line 112 of file tokens.h.

◆ playbackMode

const TfToken playbackMode

"playbackMode"

UsdMediaSpatialAudio

Definition at line 116 of file tokens.h.

◆ previews

const TfToken previews

"previews"

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

Definition at line 120 of file tokens.h.

◆ previewThumbnails

const TfToken previewThumbnails

"previews:thumbnails"

Full key in the assetInfo dictionary for thumbnails previews dictionary.

Definition at line 124 of file tokens.h.

◆ previewThumbnailsDefault

const TfToken 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.

◆ spatial

const TfToken spatial

"spatial"

Fallback value for UsdMediaSpatialAudio::GetAuralModeAttr()

Definition at line 132 of file tokens.h.

◆ SpatialAudio

const TfToken SpatialAudio

"SpatialAudio"

Schema identifer and family for UsdMediaSpatialAudio

Definition at line 148 of file tokens.h.

◆ startTime

const TfToken startTime

"startTime"

UsdMediaSpatialAudio

Definition at line 136 of file tokens.h.

◆ thumbnails

const TfToken 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: