Skip to content

[New Capability] Streaming Media for Edge Network#126

Merged
addb merged 34 commits intodevfrom
media
Nov 30, 2023
Merged

[New Capability] Streaming Media for Edge Network#126
addb merged 34 commits intodevfrom
media

Conversation

@addb
Copy link
Copy Markdown
Contributor

@addb addb commented Nov 29, 2023

Description

Media Tracking Support

🎉 New Features

  • Added support for Media Tracking.
  • Added new Media APIs:
    • createMediaSession()
    • sendMediaEvent()
  • Supports custom ping interval for main and ad content.
  • Automatic idle session detection and timeout (Ends idle session).
  • Automatic restart for long running sessions.
  • Supports 1 active media session at a time.
  • Automatically ends previous session if new session created without closing the old one.

📓 Documentation Update

  • Added detailed Migration guide from Media SDK to AEP SDK
  • Updated API reference with Media APIs

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

yangyansong-adbe and others added 30 commits October 19, 2023 11:19
Support path overwrite in Edge requests
Update configuration module to support media keys
* port the POC code

* tmp

* tmp

* cleanup

* more cleanup

* delete unused sessions

* typo

* add tests for _adb_isStringInArray()

* add tests for media config keys

* Add two timestamp formats to the same event

* remove unused log

* add tests for Media APIs

* add tests for _adb_isValidMediaXDMData

* add tests for EventProcessor

* add tests for _adb_MediaModule

* add a test file for mediaSessionManager()

* cleanup

* address review comments

* address review comments

* small cleanup

* add a TODO

* rename a function
* exploration 1

* Allow generating multiple SDK API instances in different UI nodes.

* remove unused code

* option 3

* cleanup

* update docs

* address review comments

* add a default id to the Adobe task node.

* fix typo
* remove several TODOs.

* change _mediaConfigIsNotReady() to _isMediaConfigReady()

* update the sample for testing media APIs

* remove _adb_sanitizeXDMData()
* refactoring the dev app for clarity

* cleanup

* update comments
* refactoring the dev app for clarity

* cleanup

* update comments

* update sample app
* Implemented sessionManager to dispatch media hits.

* rename ts fields

* More cleanup and refactor

* More updates

* Cleaned up code. Added logic to restart for idle and long running sessions. Added todos in MediaSession.

* Add logic to create sessionresume and sessionend pings at the session level. Added code to handle sessionstart failure.

* Add range for ping intervals and add constants.

* Fix compile errors, test errors, commented failing tests.
* update API references for media tracking APIs

* update TOC

* address review comments

* Update api-reference.md

* address review comments

* address review comments

* Update api-reference.md
* Add unit tests for Media module

* Add tests for MediaSessionManager

* Fix issues in MediaSession

* Add more tests for session manager

* Add tests for MediaSession

* Add more tests for MediaSession and fixes for MediaSession

* Added more tests for MediaSession and more fixes.

* Added more tests for session. Fixed issues and rearranged code.

* Clean test code
* Add more tests and fixes for MediaSession.

* Fix Idle timeout value

* Add test cases for closeIfIdle and restartIdle functions

* Update based on review

* Add tests for restartIfLongrunningsession and added fixes

* Add tests and fixes for shouldQueue

* Add tests and fixes for queue()

* Add tests for processEdgeRequestQueue

* Add todos for remaining test

* Add tests and fixes and refactors.

* Cleanup MediaSessionManagerTests

* Add tests for tryDispatchMediaEvents

* Fixes in MediaSession

* Add more tests in MediaSession

* Refactor code for readability

* Update channel name and player name for sample app

* Add more tests for process long running session
* handle session-level configuration

* update tests
* update getting-started doc

* Update getting-started.md

* Update getting-started.md
* tmp

* add integration tests for media tracking APIs

* address review comments
* mp

* add session level configuration in the sample app

* rename a var
* update API doc with media supported configuration data

* Update api-reference.md

* Update api-reference.md

* Update api-reference.md

* Update api-reference.md
* update version to 1.0.0-alpha

* address review comments
* Cleanup logs

* Mark unused variables

* minor fix

* Review updates

* Review update
addb and others added 3 commits November 22, 2023 11:33
* draft

* update migration doc

* Update media-migration.md

* Update migration guide (#118)

* Update migration guide with list of APIs on media and aep sdks

* format updates

* format fix

* Add toc and format updates

* Update format

* format updates

* Update samples

* Update format

* Update content

* update format

* Updates based on reviews

* format change

* Update content

* Update name

* update wording

* format fix

* Update typo

* Update typos in api comparison

* Add content to migration guid

* Updates based on reviews

---------

Co-authored-by: yansong <yanyang@adobe.com>
…or Refactor (#124)

* Add tables with required fields in the schema

* Update the table header

* Update structure of the documentation

* Update format

* Update format

* Updates based on discussion

* Add table about required fields in the migration guide

* Review updates

* Add doc to use custom ping interval

* Update logic to extract sessionConfiguration

* Fix code and typos

* Add sample to update ping interval
* Log improvements and minor refactoring.

* updated api-reference, added links to samples for migration guide table. Removed resolved TODO

* Update api-reference
@addb addb requested a review from praveek November 29, 2023 00:47
* Update SDK names in the documentation

* Add some description in migration guide
@addb addb merged commit 8b92636 into dev Nov 30, 2023
@praveek praveek deleted the media branch December 13, 2023 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants