zegoliveroom_plugin 1.0.9

  • Readme
  • Changelog
  • Example
  • Installing
  • 82

zegoliveroom_plugin pub package

Chinese Version

Zego's audio and video Flutter SDK provides live video and real-time audio and video services.

Learn more about the solution: https://www.zego.im

I. Download Flutter SDK #

https://flutter.dev/docs/get-started/install

II. Configuration development environment #

  1. Android Studio: Preferences->Plugins, search for the Flutter plugin to download, configure the first step to download the Flutter SDK path in the plugin.

  2. Visual Code: Search for the Flutter extension in the app store and download

After configuring the flutter environment in any of the above development environments, execute the flutter doctor on the command line and complete the related undownloaded dependencies according to the prompts.

III. Apply for Zego App ID #

Log in to Official Website to register an account, select a scenario according to your actual business needs, and obtain AppID and App Sign for initializing the SDK.

IV. Import zegoliveroom_plugin #

Open the pubspec.yaml in the project to be imported and add the zegoliveroom_plugin dependency:

  • Dependent in pub form:
dependencies:
  flutter:
    sdk: flutter

  zegoliveroom_plugin: ^1.0.9
  • Dependent in git form:
dependencies:
  flutter:
    sdk: flutter

  zegoliveroom_plugin:
    git:
      url: git://github.com/zegoim/zego-flutter-sdk.git
  • Dependent in git form and specify the branch:
dependencies:
  flutter:
    sdk: flutter

  zegoliveroom_plugin:
    url: git://github.com/zegoim/zego-flutter-sdk.git
    ref: branch_name

V. Init SDK #

import 'package:flutter/material.dart';
import 'package:zegoliveroom_plugin/zegoliveroom_plugin.dart';

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {

  // Fill in the AppID actually obtained from the official website
  final int appID = 00000000;
  // Fill in the AppSign actually obtained from the official website
  final String appSign = '0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,'
                         '0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,'
                         '0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,'
                         '0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00';

  String version = '';

  @override
  void initState() {
    super.initState();

    // get SDK version
    ZegoLiveRoomPlugin.getSdkVersion().then((ver) {

      setState({
        version = ver;
      });

    });

    // init SDK
    ZegoLiveRoomPlugin.initSDK(appID, appSign);
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Zego Plugin example app'),
        ),
        body: Center(
          child: Text('Version: $version'),
        ),
      ),
    );
  }
}

Please refer to the API usage for more features.

VI. API documentation #

Reference ZegoLiveRoomPlugin API Reference

VII. FAQ #

1. Solve the problem of compiling errors of ZegoLiveRoomApi-AudioIO and audio_in_output modules on iOS platform

Open the iOS project file Runner. xcworkspace -> Build Settings, change Compile Sources As to Objective-C++, recompile.

2. iOS compiler error: ld: symbol(s) not found for architecture x86_64

Compilation with the simulator is not supported, please use real device debugging for best results.

3. iOS uses Platform View error: [VERBOSE-2:platform_view_layer.cc(28)] Trying to embed a platform view but the PaintContext does not support embedding

Open the iOS project that requires Platform View and add the field io.flutter.embedded_views_preview to Info.plist with a value of YES.

1.0.9 #

Fix the problem that Android can't receive media sideinfo callback

1.0.8 #

  1. add setVideoMirrorMode API
  2. update iOS/Android native sdk

1.0.7 #

  1. fix android texture render crash into background
  2. fix android startPlayingStream bugs
  3. update android native sdk

1.0.6 #

  1. fix some bug and crash
  2. add log system

1.0.5 #

  1. add peer to peer delay/package lost rate.
  2. add remote user's device state notification(on/off)
  3. add remote user's first frame notification
  4. update native sdk
  5. promote stability

1.0.4 #

  1. add sound-level module
  2. add error-code module
  3. update native sdk

1.0.3 #

Add Platform View API

1.0.2 #

  1. update native sdk
  2. fix crash
  3. refactor api structure

1.0.1 #

format接口

1.0.0 #

初次发布正式版1.0

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  zegoliveroom_plugin: ^1.0.9

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:zegoliveroom_plugin/zegoliveroom_plugin.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
64
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

We analyzed this package on Oct 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/src/zego_api_defines.dart.

Run flutter format to format lib/src/zego_api_defines.dart.

Format lib/src/zego_api_error_code.dart.

Run flutter format to format lib/src/zego_api_error_code.dart.

Format lib/src/zego_liveroom.dart.

Run flutter format to format lib/src/zego_liveroom.dart.

Fix additional 6 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/zego_liveroom_audio.dart (Run flutter format to format lib/src/zego_liveroom_audio.dart.)
  • lib/src/zego_liveroom_event_channel.dart (Run flutter format to format lib/src/zego_liveroom_event_channel.dart.)
  • lib/src/zego_liveroom_player.dart (Run flutter format to format lib/src/zego_liveroom_player.dart.)
  • lib/src/zego_liveroom_publisher.dart (Run flutter format to format lib/src/zego_liveroom_publisher.dart.)
  • lib/src/zego_media_side_info.dart (Run flutter format to format lib/src/zego_media_side_info.dart.)
  • lib/src/zego_sound_level.dart (Run flutter format to format lib/src/zego_sound_level.dart.)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8