Client Start Streaming Operation

Last updated: 2025-01-23

1. Client Usage Guide

This document provides functional instructions for the PolyLive 4.x version of the broadcasting client.

The PolyLive client for broadcasting is widely compatible with diverse live streaming scenarios. In terms of viewing formats, it offers multiple options such as pure video, three-screen layout, and portrait/landscape modes. In terms of application scenarios, it supports marketing promotions, large conferences, professional training, online classrooms, and more.

Additionally, it boasts powerful features, including flexible layout of live video streams and support for multi-scene switching; the ability to add rich media such as multimedia, images, and documents; compatibility with external capture cards; and advanced functions like AI keying, AI beautification, and 17-person video co-streaming, catering to the diverse needs of different users.

2. Preparation Before Starting

1. Hardware / Environment Recommendations

Computer Hardware Configuration:

Optional Hardware:

• Shooting: External camera, camcorder + capture card;
• Audio Recording: Lavalier microphone, headset microphone, professional microphone;
• Audio Output: Headphones, external speakers;
• On-site: Green, red, blue screens;
• Network: Ethernet cable, 4G network aggregator.

2. Live Streaming Client Download

• Windows (64-bit) client download link: https://soft.polyv.net/rc/PolyvLiveSetup64.exe
• Windows (32-bit) client download link: https://soft.polyv.net/rc/PolyvLiveSetup.exe
• Mac client download link: https://soft.polyv.net/rc/PolyvLiveSetup.dmg
• Notes on Using the Client on Mac

3. Registration and Login

• Register for a Polyv account and obtain the channel ID and password
  • Register and log in to the Polyv backend, then go to Cloud Live Streaming -> Create a new channel. Upon successful creation, the channel ID and password will be displayed.

• Log in to the client using the channel number and password. Obtain the live channel number and password from the management backend to log in.
  • When logging in with the channel number as an instructor, you can start/end the live stream.
  • When logging in via a sub-channel and the co-streaming limit is 0 (co-streaming feature is not used), you can log in to the client in conjunction with the backend cloud director console.
  • When logging in via a sub-channel and the co-streaming limit is ≥1 person, you cannot log in to the client.

III. Main Interface Overview

• The 4.x client supports two live streaming templates: video-only and three-panel (document + video). The main differences are as follows:

• Pure Video Template

• Three-Part Screen Template (Document + Video)

4. Mode Switching

• The client has up to three options for different usage methods.

5. How to Perform Device Debugging

• Click the Device Debugging button at the top of the client to open a pop-up dialog.

• Microphone
  • When the microphone is working properly, a level bar will show movement while speaking. If it does not appear, try switching devices or modifying system settings.
  • Adjusting the microphone volume will change the volume heard by the viewer.
  • When external noise is high, increase the noise reduction level, but this may make the sound sharper and quieter. Please adjust appropriately.
  • If the input sound is low, increase the microphone boost, but this may cause popping sounds. Please adjust appropriately.

• Speaker
  • Speaker test: Click to play audio. If you hear sound locally, the speaker is functioning normally; otherwise, switch devices or adjust system settings.
  • Live-only mode (number of connected participants is 0): Adjusting the speaker volume affects the system sound that the audience hears from the computer. For example, turning it down will reduce the volume of system sounds like music that the audience hears.
  • Live + connected mode: Adjusting the speaker volume affects the local external playback volume but does not affect the sound heard by remote users. To allow remote users to hear the computer's system sound, enable the [Capture system sound] feature in the settings.

VI. How to Use the Documentation

• After uploading, all PPTs undergo transcoding. A small number of PPTs may have partial content compatibility issues after transcoding. Please refer to the recommendations for uploading PPTs.
• Under the pure video template, documents do not support animated PPT transcoding.
• Documents can be uploaded first in the management backend; the client does not need to re-upload and can apply them directly.

1. Video-Only Template

• To add a document, click Add Material > Cloud Document in the left function menu bar, or in the right resource function menu, go to Scene > All > Material + > Cloud Document. Both actions will open the document addition dialog. You can upload local document courseware to the server. After switching computers, log in to the same channel, and you can directly use the uploaded document courseware without re-uploading.

• After successfully uploading the courseware document, click "Apply" to display the document and its properties in the live preview area. Click [Switch Document] to open a pop-up for replacement.
  • Supports dragging the horizontal scroll bar for quick page navigation, turning pages one at a time.
  • Only one document material is supported per scene. After adding a document for the first time, it will automatically fit the full screen in the preview window.

• Switching Whiteboards
  • After adding a document, click the Whiteboard button next to the document name.
  • The system provides 50 whiteboards by default.
• Pen Annotation
  • After adding a document material, select the document and click the Pen button to expand the pen tool, allowing you to draw lines and annotate on the document.
  • Annotations will be recorded on each page of the document or whiteboard and will be captured and streamed in real time.
  • Once the pen annotation feature is in use, document materials cannot be dragged or repositioned in the preview area. After collapsing the pen tool, you can drag the document materials again.

2. Document + Video Template (Three-Panel Layout)

• To add a document, click the Document button in the left navigation bar. This will open a document selection pop-up window. Click Upload Courseware to upload a new local document.

• Use the whiteboard: When the default software opens, the whiteboard feature is displayed by default, with 50 whiteboards available for use.
• Switch between documents and whiteboard: For documents that have already been added, a document name tab will appear on the right side of the whiteboard. Click the tab to switch to another document.
• Document page navigation: Click the [Expand] button to display page navigation, allowing quick page turning to locate a specific whiteboard. Click again to collapse the navigation.
• Pen annotation: In the whiteboard or application document, you can annotate and write.
• Switch between document and video: Click the [Switch] button to swap the positions of the document and video. Click again to restore the original layout.
• Full-screen document display: When the document is the main view, click the [Full Screen] button to maximize the document display. This is suitable for scenarios where the document needs to be projected locally for the audience to view. Press ESC to exit full-screen mode.

7. How to Screen Share

1. Document-Only Template

• Differences between screen sharing methods: The client provides three screen sharing methods (generally, "Desktop Live Streaming" is sufficient).
  • Desktop Live Streaming: Suitable for most screen sharing live streaming scenarios. When enabled, the client interface collapses into a top toolbar. The host side will not experience a looping screen. More operations can be accessed via the top toolbar, such as turning on the camera, toggling the microphone, interacting with users, switching to share another screen, or switching to region sharing.
  • Desktop Window: Suitable for multi-monitor setups. When enabled, it is similar to adding a document resource. The preview will automatically fit to full screen, and you can adjust the position and size in the preview area.
  • Application Window: Suitable for live streaming scenarios where only the application window needs to be shared without the entire desktop. When in use, the shared application must not be minimized; otherwise, the broadcasted application screen will freeze on the last static frame before minimization.
• To switch to Desktop Live Streaming, click the Screen Share button in the left navigation bar and select Desktop Live Streaming. The client software will then collapse into a top toolbar style.

• Add a desktop window: Click the Screen Share button in the left navigation bar, select Desktop Window, or in the right resource bar, go to Scene -> "All" -> "Material" + -> Desktop Window. This will add the shared desktop screen, which automatically fits the preview window in full screen by default. After adding, you can modify it to another screen (if multiple monitors are available) in the properties area.
• Add a software window: Click the Screen Share button in the left navigation bar, select Software Window, or in the right resource bar, go to Scene -> "All" -> "Material" + -> Software Window. This will open a software window selection dialog, where you can choose the software window to share.

2. Document + Video Template

• Use screen sharing. Click the Screen Sharing button in the left-side function navigation, and the client software will collapse into a top function bar style. More operations can be accessed via the top function bar, such as turning on the camera, toggling the microphone, displaying chat & members, using interactions, enabling co-hosting, switching sharing, etc.

8. How to Insert Multimedia

• Adding Multimedia
  • You can click the Multimedia button in the left function navigation, or in the right resource function bar, go to Scene → "All" → "Material" + → Multimedia (only supported in pure video templates). A system dialog will then appear, guiding you to select the multimedia video you want to play.
  • The added multimedia will automatically fill the preview window in full screen. Once the multimedia is successfully added, the multimedia property operation panel will appear.

• Switch Media: After adding a multimedia video, click Switch Media to replace it with a different video for playback.
• Media Loop Modes: Options include Single Loop, Sequential Play, Loop Play, and No Loop (default).
• Local Playback Sound: When playing multimedia locally, the sound will not be output to the host who is currently streaming, to prevent echo. If the host needs to hear the multimedia sound locally, click Local Mute to disable local muting. Ensure that after disabling local muting, there is no echo on the audience side.
• Recommended Media File Specifications: It is recommended that the bitrate of inserted multimedia files does not exceed 10 Mbps, the resolution does not exceed 1920 x 1080, and the frame rate does not exceed 30 fps. Before starting the stream, use a video compression tool to process the file before adding it, to avoid streaming issues caused by insufficient computer performance.

9. How to Connect with the Audience via Co-hosting

• The co-hosting feature is only available in the Live + Co-hosting mode. Please ensure that the number of co-hosting participants in the channel created in the backend is greater than 0.
• For the supported platforms, the client must select the Live + Co-hosting mode. The co-hosting feature can only be enabled after the live stream has started and is only supported in Scenario 1. See the table below for supported platforms.

• How to Enable and Disable Co-hosting
  • Start Co-hosting: After the live stream begins, click the [Co-hosting] button in the left toolbar to open the co-hosting dialog. Click [Start Co-hosting]; the button turns red and displays [End Co-hosting].
  • Audience Request: The audience sees a co-hosting request feature. After a user applies, the [Go on Stage] button appears in the member management panel on the right.
  • Co-hosting Operation: Click the [Go on Stage] button to start an audio/video call with the audience member.
  • Co-hosting Continuation: Closing the co-hosting popup does not interrupt the session. Only clicking [End Co-hosting] will terminate all calls.

• Changing the co-hosting method
  • Fixed co-hosting method: Once co-hosting starts, the method cannot be changed; the default is video co-hosting.
  • Modifying the co-hosting method: To switch to audio co-hosting, the current co-hosting session must be ended first.
  • Audio co-hosting applicable scenarios: Suitable for viewers who do not need to show their faces or have poor network conditions.
• Changing the video layout
  • Local screen projection layout: To allow offline viewers to see equally sized co-hosting screens, switch the video layout to the tiled layout.
  • Does not affect the online layout: This operation does not affect the screen layout for online viewers.
  • Modifying the online layout: To adjust the screen layout for online viewers, go to [Settings] - [Other Settings] - [Stream Mixing Layout] to make changes.

10. How to Manage Members

• In live-only mode, members can be muted or removed.
• In live + co-host mode, members can be muted, removed, have their microphone or camera toggled (for users already connected), be taken off stage, granted/revoked presenter permissions, granted/revoked drawing permissions, set as the primary view, or muted globally.
• Special members — instructors, teaching assistants, administrators, and guests — are designated as special roles with a special title identifier. They cannot be muted or removed.
• Audience members are regular members and can be managed by instructors, teaching assistants, administrators, and guests.
• Search for members: Enter a keyword from a member's nickname, click the search button, and a list of members whose nicknames contain the keyword will be matched. The host can then manage them further.
• Obtain the guest sub-channel number and password: Under the Document + Video channel, go to the management backend -> Role Permissions, where you can add a guest and obtain the guest's sub-channel number and password.

• Presenter Permission: In live streaming + co-hosting mode, within a channel, the instructor always holds presenter permission, while guests can be granted presenter permission by the instructor. Once granted, the user can operate documents, synchronize page turns with others, use annotation tools, share screens, play multimedia, and initiate interactive features. Upon receiving presenter permission, annotation permission is automatically granted. The instructor can only grant presenter permission to one person at most.
• Annotation Permission: In live streaming + co-hosting mode, within a channel, guests who have joined the stage can be individually granted annotation permission. This allows the user to annotate on the current document or whiteboard but not to turn pages. The instructor can grant annotation permission to multiple users, but the number must not exceed the number of users on stage.
• Set as Primary View: In live streaming + co-hosting mode, when a user on stage is set as the primary view, they occupy the main position in both the client and viewer screens, highlighting their importance.
• Member Operation Permission Table: In live streaming + co-hosting mode, see the table below.

• Pure video templates do not support syncing document whiteboard page turns with others, nor do they allow multiple users to write or draw on a single document simultaneously.

11. Scenes and Materials (Pure Video Only)

• Scenes
  • Multiple scenes can be added to a live stream, each representing a different visual content. During the live stream, you can switch between scenes.
  • For example, before the official broadcast begins, you can show the audience a warm-up video scene. Once the live stream officially starts, switch to the scene of the event venue.
  • Each scene can have multiple materials added.
• Materials
  • Basic elements that make up the live stream's visual content, including cameras, screen sharing, multimedia, documents, images, text, etc. Multiple materials can be added to the same scene to compose the desired visual. For instance, in a teaching scenario, both the teacher's document and camera can be displayed simultaneously.
  • When a material is in a draggable and editable state, its border is red. When a material is selected but not draggable or editable, its border is blue.

12. How to Switch Between Multiple Scenes (Pure Video Only)

The multi-scene switching feature allows you to present different visual content to the audience during a single live stream.

For example, before the official live stream starts, you may only need to play a warm-up video. Once the stream begins, you may need to display document content. During the stream, you might want to show an exciting lottery screen, and near the end, present QR codes for event registration and follow-up. To meet these requirements, you can create four scenes, each with its own pre-configured materials and layout. During the live stream, you only need to focus on the switching order.

• Adding a Scene
  • In the resource panel on the right, go to Scenes → click the “+” under “All” to add a new scene below the current one.
  • A newly added scene contains no materials by default.

• Switching Scenes
  • Click the target scene name to switch to it.
  • When switching to a scene, the content displayed in the preview window is what the audience sees in the live stream.
  • Double-click the "Scene Name" to edit it.

13. How to Use Image and Text Materials (Video Only)

• Adding Images

  • In the right-side resource panel, go to [Scene] -> "All" -> [Material] [+] -> [Image] to add an image material.
  • The added image will automatically fit the full screen of the preview window. Supported formats include common image types such as bmp, jpg, png, and gif.
  • After adding an image, you can adjust its opacity in the properties panel.
  • In the preview area, hold down the Alt key while dragging to crop the image.
  • In the preview area, hold down the Shift key while dragging to freely scale the image.

• Adding Text

  • In the right-side resource panel, go to [Scene] -> "All" -> [Material] [+] -> [Text] to add text.
  • After adding, a red selection box will appear in the upper-left corner of the preview window.
  • In the properties panel, edit the text content and attributes, including font, font size, color, direction, and whether to enable scrolling.

14. How to Edit the Content Layout of the Preview Window (Pure Video Only)

During a live stream, the content displayed in the preview window is exactly what is broadcast. Therefore, adjusting the size, position, and layout of various materials within the preview window directly affects the audience's viewing experience.

• Adjusting the Layer Order of Materials
  • If the live stream画面 consists of a PPT overlay with a camera feed, ensure there are two materials: the PPT layer and the camera layer, with the camera layer positioned above the PPT layer to avoid being obscured.
  • Adjustment method: In the right-side panel, go to Scene > "All" > "Materials", select the material you want to adjust, and drag it up or down to change the layer order.

• Adjust the position of a material in the preview screen
  • Select the material you want to adjust. A red border will appear around it, indicating it is editable and draggable. Drag it directly to the desired position in the preview screen.
  • If there are too many materials to easily select, first choose the target material in the "Add Material" area of the resource menu, then drag and adjust it in the preview screen.

• Adjust the visibility of materials in the preview screen
  • Select the material to be adjusted, and in the resource function menu bar at the material addition section, click the eye icon to hide the material.
  • Click the eye icon again to unhide and restore the material's display in the screen.

15. Introduction to Chat, Questions, and Q&A

The chat, questions, and Q&A features respond to the backend settings of the channel. In the admin backend, chat and questions are enabled by default. If the corresponding feature menu is missing on the client side, you need to enable it in the admin backend.

• Chat feature: A public chat room where users can send text, emojis, and images. It supports muting likes and tip messages, enabling/disabling global mute, and quoting and replying to user messages.
• Questions feature: Messages from the audience are only visible to specific members and can be replied to; other audience members cannot see them.
• Q&A feature: Messages from the audience are only visible to specific members and can be replied to. Instructors, teaching assistants, and administrators can send private messages to individual audience members or broadcast messages to all audience members.

16. Introduction to Interactive Features

Interactive features enhance communication and engagement between hosts/instructors and the audience, making live streams more enjoyable and increasing audience participation. In the left-side function navigation, click Interactive to open the feature pop-up. If the pop-up does not include the interactive feature you need, please confirm with your business representative whether it has been enabled.

• Announcement: When an announcement is sent, a forced pop-up window will appear on the audience side for strong reminder scenarios.
• Check-in: Tracks the number of attendees within a specified time period.
• Lucky Draw: Used to liven up the live stream atmosphere or increase viewer engagement. Supports setting prize details, claim information, etc., to improve prize distribution efficiency.
• Quiz Card: Used for in-class quizzes to reinforce learning. Supports sending questions with only options or questions with both a stem and options.
• Survey: Used for exams in teaching or surveys in marketing. Supports multiple-choice questions and subjective questions.
• Red Packet Rain: Used to energize the live stream atmosphere.

17. How to Use Local Recording to Save Live Stream Files (Video Only)

• The cloud recording feature automatically records during the live stream. After the stream ends, the recorded content can be viewed and downloaded from the playback management page in the admin console. Additionally, a local recording save feature is provided to eliminate the download step.
• Enabling/Disabling Local Recording
  • Go to Settings -> Local Recording to enable the local recording feature. You can modify the default save path for recording files and the video format.
  • When using local recording, ensure sufficient disk space on your computer for saving videos; otherwise, videos may not be saved properly.
  • Using local recording will increase CPU consumption on your local computer. If your computer configuration is insufficient, it may severely impact the live stream process. Be sure to test this feature before use.

18. How to Set Required Encoding Parameters

Encoding parameters are critical to the live streaming effect. Default parameters are generally used, but adjusting them in specific scenarios can optimize the live streaming effect, such as:

• Screen recording teaching live streams

  • If the live stream primarily involves screen sharing or screen recording, to improve clarity, ensure the live stream resolution matches the shared screen resolution. For example, if the monitor resolution is 1920x1080, adjust the resolution to 1920x1080 in the settings and appropriately adjust the bitrate based on network conditions.

• Business roadshows and conference live streams

  • When the footage includes a large number of people moving or dance movements with significant changes, maintain a resolution of 1280 x 720, increase the frame rate to 25–30, and raise the bitrate to above 1000 kbps. Adjust the push stream quality to 2–3 as appropriate.
  • If the live stream network is stable and the uplink is guaranteed, you can choose a fixed bitrate to increase clarity (only supported in live streaming scenarios). The actual effect should be determined by on-site adjustments and viewing after the stream is broadcast.

19. Channel Selection

• When using a hardware mixer, if the sound from the phone's speaker is unclear but plays normally through headphones, it may be due to incorrect left and right channel wiring on the mixer causing sound cancellation. Solution: Without changing the mixer wiring, set the audio channel to mono.
• Under normal circumstances, keep the default stereo setting.

20. Client-Related Issues

• Common Issues with Client Broadcasting
• Qt WebEngine LGPLv2.1 License Notice