The main include file for the Omniverse Client Library.
OmniClientAclEntry: ACL Entry.
OmniClientBookmark: A bookmark.
OmniClientBranchAndCheckpoint: Branch & Checkpoint.
OmniClientCredentials: Credentials to sign in with.
OmniClientListEntry: List Entry.
OmniClientServerInfo: Server Info.
OmniClientUrl: A URL broken into the component pieces.
OmniClientAccessFlags: Access flags.
OmniClientChannelEvent: Channel Event.
OmniClientConnectionStatus: Connection Status.
OmniClientCopyBehavior: Copy Behavior.
OmniClientFileStatus: File Status.
OmniClientItemFlags: Item flags.
OmniClientListEvent: List Subscribe Event.
OmniClientLogLevel: Log Level.
OmniClientResult: The primary result code returned by the asynchronous functions.
omniClientAddBookmark: Add a URL to the list of bookmarks.
omniClientAddDefaultSearchPath: Add a default search path to the list of search paths used by resolve.
omniClientAddUserToGroup: Add user to a group.
omniClientAllocContent: Allocate a content buffer with the specified size.
omniClientAuthenticationCancel: Call this to cancel the current authentication process.
omniClientBreakUrl: Parse a URL into the components pieces.
omniClientBreakUrlAbsolute: This version of omniClientBreakUrl behaves slightly differently for raw file paths.
omniClientCombineUrls: This combines a URL with an explicit base URL.
omniClientCombineWithBaseUrl: This calls omniClientCombineUrls with the URL on the top of the stack.
omniClientCombineWithBaseUrl2: This calls omniClientCombineUrls with the URL on the top of the stack.
omniClientCopy: Copy a thing from ‘srcUrl’ to ‘dstUrl’.
omniClientCopyContent: Copy a content buffer.
omniClientCreateCheckpoint: Create a checkpoint for a given URL (which can include a branch, otherwise assume the default branch)
omniClientCreateFolder: Create a folder.
omniClientCreateGroup: Create a group on server.
omniClientDelete: Delete something (file, folder, mount, live object, channel etc..)
omniClientFreeBranchAndCheckpoint: Free the structure returned from omniClientGetBranchAndCheckpointFromQuery.
omniClientFreeContent: Free an allocated content buffer.
omniClientFreeUrl: Free the URL structure allocated by omniClientBreakUrl or omniClientBreakUrlAbsolute.
omniClientGetAcls: Retrieve the ACLs for an item.
omniClientGetBaseUrl: Returns the top of the base URL stack.
omniClientGetBranchAndCheckpointFromQuery: Breaks a query string into the branch/checkpoint parameters.
omniClientGetConnectionStatusString: Retrieve a human readable string for a connection status.
omniClientGetDefaultSearchPaths: Retrieve the current list of default search paths.
omniClientGetFileStatusString: Retrieve a human readable string for a file status.
omniClientGetGroups: Returns a list of all groups registered with the server.
omniClientGetGroupUsers: Returns a list of users associated with a group.
omniClientGetLocalFile: Get a local file name for the URL.
omniClientGetLogLevelChar: Retrieve a single character to represent a log level.
omniClientGetLogLevelString: Retrieve a human readable string for a log level.
omniClientGetReactor: Get access to the reactor.
omniClientGetResultString: Retrieve a human readable string from a result.
omniClientGetServerInfo: Retrieve information about the server for a specified URL.
omniClientGetUserGroups: Returns all groups a user belongs to.
omniClientGetUsers: Returns all users registered with the server.
omniClientGetVersionString: Returns a human-readable version string.
omniClientInitialize: Perform some one-time initialization.
omniClientJoinChannel: Start listening to a channel.
omniClientList: Retrieve contents of a folder.
omniClientListBookmarks: Register a callback to receive the list of bookmarks.
omniClientListCheckpoints: Returns a list of checkpoints for a URL.
omniClientListSubscribe: Subscribe to change notifications for a url.
omniClientLiveConfigureJitterReduction: Set parameters that control jitter reduction.
omniClientLiveCreate: Create a live object.
omniClientLiveGetLatestServerTime: Returns the server timestamp of the most recently received message (0 if no messages have been received)
omniClientLiveProcess: Call this to send live updates to the server and process live updates received from the server.
omniClientLiveProcessUpTo: Same as omniClientLiveProcess but you can specify a server time to stop processing updates.
omniClientLiveRead: Read a live object and set up a subscription to be notified of new updates to that object.
omniClientLiveRegisterProcessUpdatesCallback: Register a callback to be notified that we are about to begin processing live updates.
omniClientLiveSetQueuedCallback: Set a function to be called any time there’s an update in the queue that needs to be processed.
omniClientLiveUpdate: Update a live object.
omniClientLiveWaitForPendingUpdates: Call this to wait for all pending live updates to complete.
omniClientLock: Lock a file so no other clients can modify it.
omniClientMakeFileUrl: This creates a “file:” URL from a path.
omniClientMakePrintable: This makes a URL safe for printing in a UI or to a console window.
omniClientMakeQueryFromBranchAndCheckpoint: This creates a query string from the parameters provided.
omniClientMakeRelativeUrl: This makes “otherUrl” relative to “baseUrl”.
omniClientMakeUrl: This creates a URL from the pieces provided.
omniClientMove: Move a thing from ‘srcUrl’ to ‘dstUrl’.
omniClientMoveContent: Attempt to take ownership of a content buffer.
omniClientNormalizeUrl: This normalizes a URL by parsing it then recomposing it.
omniClientPopBaseUrl: Pop a base URL from the context stack.
omniClientPushBaseUrl: Push a base URL for relative URLs to resolve against.
omniClientReadFile: Read the entire file.
omniClientReconnect: Attempt to reconnect, even if the previous connection attempt failed.
omniClientReferenceContent: Reference an existing content buffer.
omniClientRegisterAuthCallback: Register a callback to provide authentication credentials.
omniClientRegisterConnectionStatusCallback: Register a callback to receive connection status updates.
omniClientRegisterFileStatusCallback: Register a callback to receive file transfer updates.
omniClientRemoveBookmark: Remove a URL from the list of bookmarks.
omniClientRemoveDefaultSearchPath: Remove a default search path from the list of search paths used by resolve.
omniClientRemoveGroup: Remove group from server.
omniClientRemoveUserFromGroup: Remove user from a group.
omniClientRenameGroup: Rename group on server.
omniClientResolve: Resolve operates similarly to stat with one major difference.
omniClientResolveSubscribe: Resolve an item, and subscribe to future changes.
omniClientSendMessage: Send a message to a channel.
omniClientSetAcls: Set ACLs for an item.
omniClientSetAlias: Redirect a URL to a different location.
omniClientSetAuthenticationMessageBoxCallback: Set a callback which is called instead of showing the “Please sign in using your browser” dialog.
omniClientSetLogCallback: Set a log callback function.
omniClientSetLogLevel: Set the log level.
omniClientSetS3Configuration: Set S3 configuration info for a given URL.
omniClientShutdown: Terminate all connections and free everything.
omniClientSignOut: Immediately disconnect from the server specified by this URL.
omniClientStat: Retrieve information about a single item.
omniClientStatSubscribe: Retrieve information about a single item, and subscribe to future changes.
omniClientStop: Stop an active request.
omniClientUnlock: Unlock a file so other clients can modify it.
omniClientUnregisterCallback: Unregister a callback.
omniClientWait: Wait for a request to complete.
omniClientWaitFor: Wait for a request to complete, but with a timeout.
omniClientWriteFile: Create a new file, overwriting if it already exists.
OmniClientAddUserToGroupCallback: This is called with the result of omniClientAddUserToGroup.
OmniClientAuthCallback: This allows you to provide credentials used to sign in to a server.
OmniClientAuthenticationMessageBoxCallback: This is called when the library needs to continue authentication in a web browser.
OmniClientBookmarkCallback: This is called with the list of bookmarks.
OmniClientConnectionStatusCallback: This is called any time any connection status changes.
OmniClientCopyCallback: This is called with the result of omniClientCopy.
OmniClientCreateCheckpointCallback: This is called with the result of omniClientCreateCheckpoint.
OmniClientCreateFolderCallback: This is called with the result of omniClientCreateFolder.
OmniClientCreateGroupCallback: This is called with the result of omniClientCreateGroup.
OmniClientDeleteCallback: This is called with the result of omniClientDelete.
OmniClientFileStatusCallback: This is called any time any file status changes.
OmniClientGetAclsCallback: This is called with the result of omniClientGetAcls.
OmniClientGetGroupsCallback: This is called with the result of omniClientGetGroups.
OmniClientGetGroupUsersCallback: This is called with the result of omniClientGetGroupUsers.
OmniClientGetLocalFileCallback: This is called with the result of omniClientGetLocalFile.
OmniClientGetServerInfoCallback: This is called with the results of omniClientGetServerInfo.
OmniClientGetUserGroupsCallback: This is called with the result of omniClientGetUserGroups.
OmniClientGetUsersCallback: This is called with the result of omniClientGetUsers.
OmniClientJoinChannelCallback: This is called with the result of omniClientJoinChannel.
OmniClientListCallback: This is called with the results of omniClientList and omniClientListSubscribe.
OmniClientListCheckpointsCallback: This is called with the result of omniClientListCheckpoints.
OmniClientListSubscribeCallback: This is called any time an item you’ve subscribed to with omniClientListSubscribe changes.
OmniClientLiveCreateCallback: Called with the result of omniClientLiveCreate.
OmniClientLiveProcessUpdatesCallback: This is called any time omniClientLiveProcess, omniClientLiveProcessUpTo or omniClientLiveWaitForPendingUpdates is called.
OmniClientLiveQueuedCallback: This is called any time we receive a live update from the network.
OmniClientLiveReadCallback: Called with the result of omniClientLiveRead.
OmniClientLiveUpdateCallback: Called with the result of omniClientLiveUpdate.
OmniClientLockCallback: This is called with the result of omniClientLock.
OmniClientLogCallback: This is called from a background thread any time the library wants to print a message to the log.
OmniClientMoveCallback: This is called with the result of omniClientMove.
OmniClientReadFileCallback: This is called with the result of omniClientReadFile.
OmniClientRemoveGroupCallback: This is called with the result of omniClientRemoveGroup.
OmniClientRemoveUserFromGroupCallback: This is called with the result of omniClientRemoveUserFromGroup.
OmniClientRenameGroupCallback: This is called with the result of omniClientRenameGroup.
OmniClientRequestId: Request Id returned from all the asynchronous functions.
OmniClientResolveCallback: This is called with the result of omniClientResolve or omniClientResolveSubscribe.
OmniClientResolveSubscribeCallback: This is called any time an item you’ve subscribed to with omniClientResolveSubscribe changes.
OmniClientSendMessageCallback: This is called with the result of omniClientSendMessage.
OmniClientSetAclsCallback: This is called with the result of omniClientSetAcls.
OmniClientStatCallback: This is called with the results of omniClientStat or omniClientStatSubscribe.
OmniClientStatSubscribeCallback: This is called any time an item you’ve subscribed to with omniClientStatSubscribe changes.
OmniClientUnlockCallback: This is called with the result of omniClientUnlock.
OmniClientWriteFileCallback: This is called with the result of omniClientWriteFile.
kInvalidRequestId: This is returned if you call an asynchronous function after calling omniClientShutdown.
kOmniClientVersion: The version of this library. You can pass it to omniClientInitialize to verify that the dll which is loaded matches the header file you compiled against.