https://github.com/g-ray/flutter_libtransmission

Simple libtransmission bindings for flutter
https://github.com/g-ray/flutter_libtransmission

Last synced: 8 days ago
JSON representation

Simple libtransmission bindings for flutter

• Host: GitHub
• URL: https://github.com/g-ray/flutter_libtransmission
• Owner: G-Ray
• License: other
• Created: 2024-10-11T16:35:38.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-10-17T13:24:16.000Z (27 days ago)
• Last Synced: 2024-10-22T22:22:25.481Z (21 days ago)
• Language: CMake
• Size: 39.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flutter_libtransmission

A new Flutter project.

## Getting Started

This project is a starting point for a Flutter

[FFI plugin](https://flutter.dev/to/ffi-package),

a specialized package that includes native code directly invoked with Dart FFI.

## Project structure

This template uses the following structure:

* `src`: Contains the native source code, and a CmakeFile.txt file for building

  that source code into a dynamic library.

* `lib`: Contains the Dart code that defines the API of the plugin, and which

  calls into the native code using `dart:ffi`.

* platform folders (`android`, `ios`, `windows`, etc.): Contains the build files

  for building and bundling the native code library with the platform application.

## Building and bundling native code

The `pubspec.yaml` specifies FFI plugins as follows:

```yaml

  plugin:

    platforms:

      some_platform:

        ffiPlugin: true

```

This configuration invokes the native build for the various target platforms

and bundles the binaries in Flutter applications using these FFI plugins.

This can be combined with dartPluginClass, such as when FFI is used for the

implementation of one platform in a federated plugin:

```yaml

  plugin:

    implements: some_other_plugin

    platforms:

      some_platform:

        dartPluginClass: SomeClass

        ffiPlugin: true

```

A plugin can have both FFI and method channels:

```yaml

  plugin:

    platforms:

      some_platform:

        pluginClass: SomeName

        ffiPlugin: true

```

The native build systems that are invoked by FFI (and method channel) plugins are:

* For Android: Gradle, which invokes the Android NDK for native builds.

  * See the documentation in android/build.gradle.

* For iOS and MacOS: Xcode, via CocoaPods.

  * See the documentation in ios/flutter_libtransmission.podspec.

  * See the documentation in macos/flutter_libtransmission.podspec.

* For Linux and Windows: CMake.

  * See the documentation in linux/CMakeLists.txt.

  * See the documentation in windows/CMakeLists.txt.

## Binding to native code

To use the native code, bindings in Dart are needed.

To avoid writing these by hand, they are generated from the header file

(`src/flutter_libtransmission.h`) by `package:ffigen`.

Regenerate the bindings by running `dart run ffigen --config ffigen.yaml`.

## Invoking native code

Very short-running native functions can be directly invoked from any isolate.

For example, see `sum` in `lib/flutter_libtransmission.dart`.

Longer-running functions should be invoked on a helper isolate to avoid

dropping frames in Flutter applications.

For example, see `sumAsync` in `lib/flutter_libtransmission.dart`.

## Flutter help

For help getting started with Flutter, view our

[online documentation](https://docs.flutter.dev), which offers tutorials,

samples, guidance on mobile development, and a full API reference.