### Interface

# Hinoko FwIsoCtx

#### Description [src]

    interface Hinoko.FwIsoCtx : GObject.Object

A set of basic interfaces to operate isochronous context on 1394 OHCI hardware. `HinokoFwIsoCtx` includes interfaces to operate 1394 OHCI hardware for isochronous communication by any kind of contexts.

#### Prerequisite

In order to implement FwIsoCtx, your type must inherit from`GObject`.

#### Implementations

- HinokoFwIsoIrMultiple
- HinokoFwIsoIrSingle
- HinokoFwIsoIt

#### Instance methods

###### hinoko_fw_iso_ctx_create_source

Create `GSource` for `GMainContext` to dispatch events for isochronous context.

since: 0.7

###### hinoko_fw_iso_ctx_flush_completions

Flush isochronous context until recent isochronous cycle. The call of function forces the context to queue any type of interrupt event for the recent isochronous cycle. Application can process the content of isochronous packet without waiting for actual hardware interrupt.

since: 0.7

###### hinoko_fw_iso_ctx_read_cycle_time

Retrieve the value of cycle time register. This method call is available once any isochronous context is created.

since: 1.0

###### hinoko_fw_iso_ctx_release

Release the context from 1394 OHCI hardware.

since: 0.7

###### hinoko_fw_iso_ctx_stop

Stop isochronous context.

since: 0.7

###### hinoko_fw_iso_ctx_unmap_buffer

Unmap intermediate buffer shared with 1394 OHCI hardware for the context.

since: 0.7

#### Properties

###### Hinoko.FwIsoCtx:bytes-per-chunk

The number of bytes per chunk in buffer.

since: 0.7

###### Hinoko.FwIsoCtx:chunks-per-buffer

The number of chunks per buffer.

since: 0.7

#### Signals

###### Hinoko.FwIsoCtx::stopped

Emitted when isochronous context is stopped.

since: 0.7

#### Interface structure

    struct HinokoFwIsoCtxInterface {
      GTypeInterface parent_iface;
      void (* stop) (
        HinokoFwIsoCtx* self
      );
      void (* unmap_buffer) (
        HinokoFwIsoCtx* self
      );
      void (* release) (
        HinokoFwIsoCtx* self
      );
      gboolean (* read_cycle_time) (
        HinokoFwIsoCtx* self,
        gint clock_id,
        HinawaCycleTime** cycle_time,
        GError** error
      );
      gboolean (* flush_completions) (
        HinokoFwIsoCtx* self,
        GError** error
      );
      gboolean (* create_source) (
        HinokoFwIsoCtx* self,
        GSource** source,
        GError** error
      );
      void (* stopped) (
        HinokoFwIsoCtx* self,
        const GError* error
      );

    }

No description available.

###### Interface members

`parent_iface`

    GTypeInterface

| No description available.

`stop`

    void (* stop) (
        HinokoFwIsoCtx* self
      )

| No description available.

`unmap_buffer`

    void (* unmap_buffer) (
        HinokoFwIsoCtx* self
      )

| No description available.

`release`

    void (* release) (
        HinokoFwIsoCtx* self
      )

| No description available.

`read_cycle_time`

    gboolean (* read_cycle_time) (
        HinokoFwIsoCtx* self,
        gint clock_id,
        HinawaCycleTime** cycle_time,
        GError** error
      )

| No description available.

`flush_completions`

    gboolean (* flush_completions) (
        HinokoFwIsoCtx* self,
        GError** error
      )

| No description available.

`create_source`

    gboolean (* create_source) (
        HinokoFwIsoCtx* self,
        GSource** source,
        GError** error
      )

| No description available.

`stopped`

    void (* stopped) (
        HinokoFwIsoCtx* self,
        const GError* error
      )

| No description available.

#### Virtual methods

###### Hinoko.FwIsoCtx.create_source

Create `GSource` for `GMainContext` to dispatch events for isochronous context.

since: 0.7

###### Hinoko.FwIsoCtx.flush_completions

Flush isochronous context until recent isochronous cycle. The call of function forces the context to queue any type of interrupt event for the recent isochronous cycle. Application can process the content of isochronous packet without waiting for actual hardware interrupt.

since: 0.7

###### Hinoko.FwIsoCtx.read_cycle_time

Retrieve the value of cycle time register. This method call is available once any isochronous context is created.

since: 1.0

###### Hinoko.FwIsoCtx.release

Release the context from 1394 OHCI hardware.

since: 0.7

###### Hinoko.FwIsoCtx.stop

Stop isochronous context.

since: 0.7

###### Hinoko.FwIsoCtx.stopped

Closure for the `HinokoFwIsoCtx::stopped` signal.

###### Hinoko.FwIsoCtx.unmap_buffer

Unmap intermediate buffer shared with 1394 OHCI hardware for the context.

since: 0.7