JvLink (Xanthos)

JvLink Module

Namespace: Xanthos
Assembly: Xanthos.dll

Synchronous SDK operations. COM executes on the session's STA; UI calls wait for the user's choice.

Functions and values

Function or value	Description
`cancel arg1` Full Usage: `cancel arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`closeData arg1` Full Usage: `closeData arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`configureUi arg1` Full Usage: `configureUi arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`connect arg1` Full Usage: `connect arg1` Parameters: arg0 : `ConnectionOptions` Returns: `Result<Session, JvError>`	arg0 : `ConnectionOptions` Returns: `Result<Session, JvError>`
`courseFile arg1 arg2` Full Usage: `courseFile arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<ImageResult<CourseImage>, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<ImageResult<CourseImage>, JvError>`
`courseFile2 arg1 arg2 arg3` Full Usage: `courseFile2 arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<ImageResult<string>, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<ImageResult<string>, JvError>`
`decodeShiftJis arg1` Full Usage: `decodeShiftJis arg1` Parameters: arg0 : `byte[]` Returns: `string`	arg0 : `byte[]` Returns: `string`
`deleteFile arg1 arg2` Full Usage: `deleteFile arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`
`disconnect arg1` Full Usage: `disconnect arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`getCurrentFileTimestamp arg1` Full Usage: `getCurrentFileTimestamp arg1` Parameters: arg0 : `Session` Returns: `Result<string, JvError>`	Returns an empty string when the SDK has no current file timestamp (null BSTR). arg0 : `Session` Returns: `Result<string, JvError>`
`getCurrentReadFileSize arg1` Full Usage: `getCurrentReadFileSize arg1` Parameters: arg0 : `Session` Returns: `Result<int, JvError>`	arg0 : `Session` Returns: `Result<int, JvError>`
`getPayFlag arg1` Full Usage: `getPayFlag arg1` Parameters: arg0 : `Session` Returns: `Result<int, JvError>`	arg0 : `Session` Returns: `Result<int, JvError>`
`getSaveFlag arg1` Full Usage: `getSaveFlag arg1` Parameters: arg0 : `Session` Returns: `Result<int, JvError>`	arg0 : `Session` Returns: `Result<int, JvError>`
`getSavePath arg1` Full Usage: `getSavePath arg1` Parameters: arg0 : `Session` Returns: `Result<string, JvError>`	arg0 : `Session` Returns: `Result<string, JvError>`
`getServiceKey arg1` Full Usage: `getServiceKey arg1` Parameters: arg0 : `Session` Returns: `Result<string, JvError>`	arg0 : `Session` Returns: `Result<string, JvError>`
`getTotalReadFileSize arg1` Full Usage: `getTotalReadFileSize arg1` Parameters: arg0 : `Session` Returns: `Result<FileSizeKilobytes, JvError>`	arg0 : `Session` Returns: `Result<FileSizeKilobytes, JvError>`
`getVersion arg1` Full Usage: `getVersion arg1` Parameters: arg0 : `Session` Returns: `Result<string, JvError>`	arg0 : `Session` Returns: `Result<string, JvError>`
`gets arg1` Full Usage: `gets arg1` Parameters: arg0 : `Session` Returns: `Result<ReadResult, JvError>`	arg0 : `Session` Returns: `Result<ReadResult, JvError>`
`getsWithCapacity arg1 arg2` Full Usage: `getsWithCapacity arg1 arg2` Parameters: arg0 : `int` arg1 : `Session` Returns: `Result<ReadResult, JvError>`	arg0 : `int` arg1 : `Session` Returns: `Result<ReadResult, JvError>`
`init arg1 arg2` Full Usage: `init arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`
`movieCheck arg1 arg2` Full Usage: `movieCheck arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<VideoAvailability, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<VideoAvailability, JvError>`
`movieCheckWithType arg1 arg2 arg3` Full Usage: `movieCheckWithType arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<VideoAvailability, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<VideoAvailability, JvError>`
`movieOpen arg1 arg2 arg3` Full Usage: `movieOpen arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<VideoOpenOutcome, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<VideoOpenOutcome, JvError>`
`moviePlay arg1 arg2` Full Usage: `moviePlay arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`
`moviePlayWithType arg1 arg2 arg3` Full Usage: `moviePlayWithType arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<unit, JvError>`
`movieRead arg1` Full Usage: `movieRead arg1` Parameters: arg0 : `Session` Returns: `Result<VideoReadOutcome, JvError>`	arg0 : `Session` Returns: `Result<VideoReadOutcome, JvError>`
`movieReadWithCapacity arg1 arg2` Full Usage: `movieReadWithCapacity arg1 arg2` Parameters: arg0 : `int` arg1 : `Session` Returns: `Result<VideoReadOutcome, JvError>`	arg0 : `int` arg1 : `Session` Returns: `Result<VideoReadOutcome, JvError>`
`openData arg1 arg2` Full Usage: `openData arg1 arg2` Parameters: arg0 : `OpenRequest` arg1 : `Session` Returns: `Result<OpenOutcome, JvError>`	arg0 : `OpenRequest` arg1 : `Session` Returns: `Result<OpenOutcome, JvError>`
`openRealtime arg1 arg2 arg3` Full Usage: `openRealtime arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<RealtimeOpenOutcome, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<RealtimeOpenOutcome, JvError>`
`parseEvent arg1` Full Usage: `parseEvent arg1` Parameters: arg0 : `JvEvent` Returns: `Result<ParsedEvent, JvError>`	arg0 : `JvEvent` Returns: `Result<ParsedEvent, JvError>`
`read arg1` Full Usage: `read arg1` Parameters: arg0 : `Session` Returns: `Result<ReadResult, JvError>`	arg0 : `Session` Returns: `Result<ReadResult, JvError>`
`readWithCapacity arg1 arg2` Full Usage: `readWithCapacity arg1 arg2` Parameters: arg0 : `int` arg1 : `Session` Returns: `Result<ReadResult, JvError>`	arg0 : `int` arg1 : `Session` Returns: `Result<ReadResult, JvError>`
`setParentWindowHandle arg1 arg2` Full Usage: `setParentWindowHandle arg1 arg2` Parameters: arg0 : `nativeint` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `nativeint` arg1 : `Session` Returns: `Result<unit, JvError>`
`setSaveFlag arg1 arg2` Full Usage: `setSaveFlag arg1 arg2` Parameters: arg0 : `bool` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `bool` arg1 : `Session` Returns: `Result<unit, JvError>`
`setSavePath arg1 arg2` Full Usage: `setSavePath arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`
`setServiceKey arg1 arg2` Full Usage: `setServiceKey arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<unit, JvError>`
`silksBinary arg1 arg2` Full Usage: `silksBinary arg1 arg2` Parameters: arg0 : `string` arg1 : `Session` Returns: `Result<ImageResult<byte[]>, JvError>`	arg0 : `string` arg1 : `Session` Returns: `Result<ImageResult<byte[]>, JvError>`
`silksFile arg1 arg2 arg3` Full Usage: `silksFile arg1 arg2 arg3` Parameters: arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<ImageResult<string>, JvError>`	arg0 : `string` arg1 : `string` arg2 : `Session` Returns: `Result<ImageResult<string>, JvError>`
`skip arg1` Full Usage: `skip arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`status arg1` Full Usage: `status arg1` Parameters: arg0 : `Session` Returns: `Result<int, JvError>`	arg0 : `Session` Returns: `Result<int, JvError>`
`subscribe arg1 arg2` Full Usage: `subscribe arg1 arg2` Parameters: arg0 : `JvEvent -> unit` arg1 : `Session` Returns: `Result<Subscription, JvError>`	Consumers run on an owned worker. Overflow or consumer exceptions stop delivery and are observable. arg0 : `JvEvent -> unit` arg1 : `Session` Returns: `Result<Subscription, JvError>`
`subscribeWithOptions arg1 arg2 arg3` Full Usage: `subscribeWithOptions arg1 arg2 arg3` Parameters: arg0 : `SubscriptionOptions` arg1 : `JvEvent -> unit` arg2 : `Session` Returns: `Result<Subscription, JvError>`	arg0 : `SubscriptionOptions` arg1 : `JvEvent -> unit` arg2 : `Session` Returns: `Result<Subscription, JvError>`
`subscriptionError arg1` Full Usage: `subscriptionError arg1` Parameters: arg0 : `Subscription` Returns: `JvError option`	arg0 : `Subscription` Returns: `JvError option`
`toRealtimeRequest arg1` Full Usage: `toRealtimeRequest arg1` Parameters: arg0 : `JvEvent` Returns: `Result<RealtimeRequest, JvError>`	arg0 : `JvEvent` Returns: `Result<RealtimeRequest, JvError>`
`unsubscribe arg1` Full Usage: `unsubscribe arg1` Parameters: arg0 : `Subscription` Returns: `Result<unit, JvError>`	arg0 : `Subscription` Returns: `Result<unit, JvError>`
`watchError arg1` Full Usage: `watchError arg1` Parameters: arg0 : `Session` Returns: `Result<JvError option, JvError>`	arg0 : `Session` Returns: `Result<JvError option, JvError>`
`watchEvent arg1 arg2` Full Usage: `watchEvent arg1 arg2` Parameters: arg0 : `JvEvent -> unit` arg1 : `Session` Returns: `Result<unit, JvError>`	arg0 : `JvEvent -> unit` arg1 : `Session` Returns: `Result<unit, JvError>`
`watchEventClose arg1` Full Usage: `watchEventClose arg1` Parameters: arg0 : `Session` Returns: `Result<unit, JvError>`	arg0 : `Session` Returns: `Result<unit, JvError>`
`withSession arg1 arg2` Full Usage: `withSession arg1 arg2` Parameters: arg0 : `ConnectionOptions` arg1 : `Session -> Result<'a, JvError>` Returns: `Result<'a, JvError>` Type parameters: 'a	arg0 : `ConnectionOptions` arg1 : `Session -> Result<'a, JvError>` Returns: `Result<'a, JvError>`