Cloud Phone:Android SDK

1.1 Obtain the SDK and demo

dependencies {
    implementation fileTree(include: ['*.jar', '*.aar'], dir: 'libs')
    // INI configuration parsing library for aspengine-sdk
    implementation 'org.ini4j:ini4j:0.5.4'
    // Dependency for wytrace
    implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.8'
    implementation 'com.google.code.gson:gson:2.10.1'
    implementation 'io.github.aliyun-sls:aliyun-log-android-sdk:2.7.0@aar'
}

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.VIBRATE"/>

1.2 Integration process

1.3 Best practices

Refer to Best practices for integrating Cloud Phone for implementation details. The following figure outlines the cloud phone integration process.

Multiple logon methods are supported to retrieve the ticket credential for cloud phone access, which is required for SDK integration. Refer to the following flowcharts:

See the "Lifecycle interfaces" section for sample integration code.

2.1 Initialize an StreamView instance

@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   requestWindowFeature(Window.FEATURE_NO_TITLE);
   getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN, WindowManager.LayoutParams.FLAG_FULLSCREEN);
   setContentView(R.layout.activity_stream_view_demo);
   mStreamView = findViewById(R.id.stream_view);
   mStreamView.enableDesktopMode(false);
   mStreamView.scaleStreamVideo(pref.getBoolean("fit_video_content", true) ?
   mStreamView.ScaleType.FIT_STREAM_CONTENT : StreamView.ScaleType.FILL_STREAM_VIEW);
   mStreamView.getASPEngineDelegate().setAlignStreamResolutionWithSurfaceSize(false);
}

<?xml version="1.0" encoding="utf-8"?>
<android.widget.RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".StreamViewDemoActivity">

    <com.aliyun.wuying.aspsdk.aspengine.ui.StreamView
        android:id="@+id/stream_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:focusableInTouchMode="true"
        android:focusable="true"
        android:focusedByDefault="true" />

</android.widget.RelativeLayout>

2.2 Establish a session

For information about valid values for mConfigs, see 4.1 Config.

mStreamView.start(mConfigs);

2.3 Disconnect from a session

mStreamView.stop();

2.4 Destroy a StreamView instance

mStreamView.dispose();
mStreamView = null;

2.5 Multi-StreamView mode

This mode supports seamlessly switching the display of a single stream between multiple View instances. To implement this feature, follow these steps:

1. Define and initialize the StreamView objects as described in 2.1.

2. Use IAspEngine to establish a connection, using parameters consistent with the Config definition in 4.1.

   IASPEngine engine = mBuilder.enableRTC(true).build(context);
   //Enable statistics collection
   engine.enableStatistics(true, true);
   ConnectionConfig cc = new ConnectionConfig();
   cc.id = CONFIG_DESKTOP_ID;
   cc.connectionTicket = CONFIG_CONNECTION_TICKET;
   cc.useVPC = CONFIG_USE_VPC;
   cc.type = OS_TYPE;
   cc.user = CONFIG_USER;
   cc.uuid = CONFIG_UUID;
   
   engine.start(cc);

3. Bind the IAspEngine to a StreamView instance. This call will begin rendering the stream on the specified View.

   mStreamView.bindASPEngine(engine);

4. To switch the display, bind the IAspEngine to a different StreamView instance. This allows the new View to take over rendering the stream.

   mStreamView.resumeASPEngine();

For a complete implementation, please refer to the provided demo application.

2.6 Callback instructions

Sample code for callback registration and deregistration:

// Listen for connection callbacks.
mStreamView.getASPEngineDelegate().registerASPEngineListener(IASPEngineListener var1);
mStreamView.getASPEngineDelegate().unregisterASPEngineListener(IASPEngineListener var1);
// Listen for performance data callbacks.
mStreamView.getASPEngineDelegate().registerStatisticsListener(IStatisticsListener var1);
mStreamView.getASPEngineDelegate().unregisterStatisticsListener(IStatisticsListener var1);
// Listen for system permission requests.
mStreamView.registerSystemPermissionListener(IRequestSystemPermissionListener listener);
mStreamView.unregisterSystemPermissionListener(IRequestSystemPermissionListener listener);

6.2.1 initialize

This method is implemented by apps and can be used to perform global initialization tasks related to the custom media engine.

This method is executed once in each streaming process.

public ErrorCode initialize()

Return value:

6.2.2 release

This method is implemented by apps and can be used to perform global release tasks related to the custom media engine.

This method is executed once in each streaming process.

public ErrorCode release()

Return value:

6.2.3 enableStatistics

This method is implemented by apps and can be used to enable or disable performance statistics collection.

public void enableStatistics(boolean enabled)

Parameters:

6.2.4 onCreateVideoStreamHandler

This method is implemented by apps and used to provide the SDK with a media engine implementation for handling video stream data.

This method is executed once in each streaming process.

public IVideoStreamHandler onCreateVideoStreamHandler()

Return value:

6.2.5 onCreateAdaptiveGraphicStreamHandler

This method is implemented by apps and used to provide the SDK with a media engine implementation for handling adaptive graphic stream data.

This method is executed once in each streaming process.

public IAdaptiveGraphicStreamHandler onCreatAdaptiveGraphicStreamHandler()

Return value:

6.2.6 onCreateAudioPlaybackStreamHandler

This method is implemented by apps and used to provide the SDK with a media engine implementation for handling audio downstream data.

This method is executed once in each streaming process.

public IAudioPlaybackStreamHandler onCreatAudioPlaybackStreamHandler()

Return value:

6.2.7 onCreateCursorBitmapHandler

This method is implemented by apps and used to provide the SDK with a media engine implementation for handling cursor data.

This method is executed once in each streaming process.

The interface provided by this method is used only when the virtual mouse mode is activated.

public ICursorBitmapHandler onCreatCursorBitmapHandler()

Return value:

6.3.1 setEventHandler

This method is implemented by apps. When the custom media engine is loaded by the Alibaba Cloud Workspace SDK, the SDK uses this method to provide an event handler to your app. The app can use this handler to send video stream processing events.

public void setEventHandler(EventHandler handler)

Parameters:

6.3.2 addVideoTrack

This method is implemented by apps. It notifies your app when a video stream is created.

Currently, only one video stream can exist at a time during a single streaming session.

ErrorCode addVideoTrack(int trackId, VProfile profile);

Parameters:

Return value:

6.3.3 setVideoSurface

This method is implemented by apps. It notifies your app when the state of the Surface instance used for video rendering changes.

ErrorCode setVideoSurface(int trackId, Surface surface);

Parameters:

Return value:

6.3.4 playVideo

This method is implemented by apps. It notifies your app when the video stream is ready.

ErrorCode playVideo(int trackId);

Parameters:

Return value:

6.3.5 removeVideoTrack

This method is implemented by apps. It notifies your app when a video stream is destroyed.

ErrorCode removeVideoTrack(int trackId);

Parameters:

Return value:

6.3.6 pushVideoFrame

This method is implemented by apps. It notifies your app when a new video frame is received.

ErrorCode setVideoSurface(int trackId, Surface surface);

Parameters:

Return value:

6.3.7 getVideoTracks

This method is implemented by apps. The SDK uses it to retrieve information about video streams currently being processed by your app.

HashMap<Integer, VProfile> getVideoTracks();

Return value:

6.3.8 release

This method is implemented by apps. The SDK uses it to notify your app to perform cleanup actions when all video streams are destroyed.

ErrorCode release();

Return value:

6.4.1 initAudio

This method is implemented by apps. When an audio channel is created within the SDK, your app is notified through this method.

ErrorCode initAudio();

Return value:

6.4.2 deInitAudio

This method is implemented by apps. When an audio channel is destroyed within the SDK, your app is notified through this method.

ErrorCode deInitAudio();

Return value:

6.4.3 startAudioPlayback

This method is implemented by apps. When the cloud phone is about to start streaming audio, your app is notified through this method.

ErrorCode startAudioPlayback();

Return value:

6.4.4 stopAudioPlayback

This method is implemented by apps. When the cloud phone stops streaming audio, your app is notified through this method.

ErrorCode stopAudioPlayback();

Return value:

6.4.5 pushAudioPlaybackFrame

This method is implemented by apps. When a new downstream audio frame is received, your app is notified through this method.

ErrorCode pushAudioPlaybackFrame(AFrame pbData);

Parameters:

Return value:

6.4.6 updateAudioPlaybackVol

This method is implemented by apps. When the system volume in the cloud phone changes, your app is notified through this method.

ErrorCode updateAudioPlaybackVol(int volume);

Parameters:

Return value:

6.4.7 updateAudioPlaybackMute

This method is implemented by apps. When the cloud phone is muted or unmuted, your app is notified through this method.

ErrorCode updateAudioPlaybackMute(int mute);

Parameters:

Return value:

6.4.8 release

This method is implemented by apps. The SDK uses it to notify your app to perform cleanup actions when an audio channel is destroyed.

ErrorCode release();

Return value:

6.5.1 setAdaptiveGraphicSurface

This method is implemented by apps. It notifies your app when the state of the Surface instance used for image rendering changes.

ErrorCode setAdaptiveGraphicSurface(Surface surface);

Parameters:

Return value:

6.5.2 invalidateAdaptiveGraphicSurface

This method is implemented by apps. It notifies your app when a new adaptive graphic frame is received.

ErrorCode invalidateAdaptiveGraphicSurface(Region region, byte[] buffer, BitmapFormat format);

Parameters:

Return value:

6.5.3 release

This method is implemented by apps. The SDK uses it to notify your app to perform cleanup actions when all adaptive graphic streams are destroyed.

ErrorCode release();

Return value:

6.6.1 setCursorBitmap

This method is implemented by apps. When the cursor graphic in the cloud phone changes, your app is notified through this method.

ErrorCode setCursorBitmap(CursorBitmap bitmap);

Parameters:

Return value:

6.6.2 unsetCursorBitmap

This method is implemented by apps. When the cursor in the cloud phone is hidden, your app is notified through this method.

ErrorCode unsetCursorBitmap();

Return value:

6.6.3 setCursorPosition

This method is implemented by apps. When the cursor position in the cloud phone changes, your app is notified through this method.

ErrorCode setCursorPosition(float x, float y);

Parameters:

Return value:

6.6.4 release

This method is implemented by apps. The SDK uses it to notify your app to perform cleanup actions when the connection is discontinued and the cursor display is canceled.

ErrorCode release();

Return value: